2006-08-22 15:57:13 +00:00
< html >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=ISO-8859-1" >
< title > map</ title >
< link rel = "stylesheet" href = "../../../boostbook.css" type = "text/css" >
2007-02-15 23:11:24 +00:00
< meta name = "generator" content = "DocBook XSL Stylesheets V1.68.1" >
2006-08-22 15:57:13 +00:00
< link rel = "start" href = "../../../index.html" title = "Chapter >
< link rel = "up" href = "../containers.html" title = "Containers" >
< link rel = "prev" href = "set.html" title = "set" >
< link rel = "next" href = "../views.html" title = "Views" >
</ head >
< body bgcolor = "white" text = "black" link = "#0000FF" vlink = "#840084" alink = "#0000FF" >
< table cellpadding = "2" width = "100%" >
< td valign = "top" >< img alt = "Boost C++ Libraries" width = "277" height = "86" src = "../../../../../../../boost.png" ></ td >
< td align = "center" >< a href = "../../../../../../../index.htm" > Home</ a ></ td >
< td align = "center" >< a href = "../../../../../../libraries.htm" > Libraries</ a ></ td >
< td align = "center" >< a href = "../../../../../../../people/people.htm" > People</ a ></ td >
< td align = "center" >< a href = "../../../../../../../more/faq.htm" > FAQ</ a ></ td >
< td align = "center" >< a href = "../../../../../../../more/index.htm" > More</ a ></ td >
</ table >
< hr >
< div class = "spirit-nav" >
< a accesskey = "p" href = "set.html" >< img src = "../../../images/prev.png" alt = "Prev" ></ a >< a accesskey = "u" href = "../containers.html" >< img src = "../../../images/up.png" alt = "Up" ></ a >< a accesskey = "h" href = "../../../index.html" >< img src = "../../../images/home.png" alt = "Home" ></ a >< a accesskey = "n" href = "../views.html" >< img src = "../../../images/next.png" alt = "Next" ></ a >
</ div >
< div class = "section" lang = "en" >
< div class = "titlepage" >< div >< div >< h4 class = "title" >
< a name = "fusion.sequences.containers.map" ></ a >< a href = "map.html" title = "map" > map</ a ></ h4 ></ div ></ div ></ div >
< a name = "fusion.sequences.containers.map.description" ></ a >< h5 >
2007-07-13 19:25:34 +00:00
< a name = "id1000149" ></ a >
2006-08-22 15:57:13 +00:00
< a href = "map.html#fusion.sequences.containers.map.description" > Description</ a >
</ h5 >
< p >
map is an < a href = "../concepts/associative_sequence.html" title = "Associative
Sequence" > Associative
Sequence</ a > of heteregenous typed data elements. Each element is a
2007-02-15 23:11:24 +00:00
key/data pair (see < a href = "../../support/pair.html" title = "pair" >< code class = "computeroutput" >< span class = "identifier" > fusion</ span >< span class = "special" > ::</ span >< span class = "identifier" > pair</ span ></ code ></ a > )
2006-08-22 15:57:13 +00:00
where the key has no data (type only). Type identity is used to impose
an equivalence relation on keys. A map may contain at most one element
for each key. Membership testing and element key lookup has constant runtime
complexity (see < a href = "../../notes.html#fusion.notes.overloaded_functions" > Overloaded
Functions</ a > ).
</ p >
< a name = "fusion.sequences.containers.map.header" ></ a >< h5 >
2007-07-13 19:25:34 +00:00
< a name = "id1000222" ></ a >
2006-08-22 15:57:13 +00:00
< a href = "map.html#fusion.sequences.containers.map.header" > Header</ a >
</ h5 >
< pre class = "programlisting" >
< span class = "preprocessor" > #include</ span > < span class = "special" > < </ span >< span class = "identifier" > boost</ span >< span class = "special" > /</ span >< span class = "identifier" > fusion</ span >< span class = "special" > /</ span >< span class = "identifier" > sequence</ span >< span class = "special" > /</ span >< span class = "identifier" > container</ span >< span class = "special" > /</ span >< span class = "identifier" > map</ span >< span class = "special" > .</ span >< span class = "identifier" > hpp</ span >< span class = "special" > > </ span >
</ pre >
< a name = "fusion.sequences.containers.map.synopsis" ></ a >< h5 >
2007-07-13 19:25:34 +00:00
< a name = "id1000315" ></ a >
2006-08-22 15:57:13 +00:00
< a href = "map.html#fusion.sequences.containers.map.synopsis" > Synopsis</ a >
</ h5 >
< pre class = "programlisting" >
< span class = "keyword" > template</ span > < span class = "special" > < </ span >
< span class = "keyword" > typename</ span > < span class = "identifier" > T0</ span > < span class = "special" > =</ span > < span class = "emphasis" >< em > unspecified</ em ></ span >
< span class = "special" > ,</ span > < span class = "keyword" > typename</ span > < span class = "identifier" > T1</ span > < span class = "special" > =</ span > < span class = "emphasis" >< em > unspecified</ em ></ span >
< span class = "special" > ,</ span > < span class = "keyword" > typename</ span > < span class = "identifier" > T2</ span > < span class = "special" > =</ span > < span class = "emphasis" >< em > unspecified</ em ></ span >
< span class = "special" > ...</ span >
< span class = "special" > ,</ span > < span class = "keyword" > typename</ span > < span class = "identifier" > TN</ span > < span class = "special" > =</ span > < span class = "emphasis" >< em > unspecified</ em ></ span >
< span class = "special" > > </ span >
< span class = "keyword" > struct</ span > < span class = "identifier" > map</ span >< span class = "special" > ;</ span >
</ pre >
< p >
2007-02-15 23:11:24 +00:00
The variadic class interface accepts < code class = "computeroutput" >< span class = "number" > 0</ span ></ code >
to < code class = "computeroutput" >< span class = "identifier" > FUSION_MAX_MAP_SIZE</ span ></ code >
elements, where < code class = "computeroutput" >< span class = "identifier" > FUSION_MAX_MAP_SIZE</ span ></ code >
is a user definable predefined maximum that defaults to < code class = "computeroutput" >< span class = "number" > 10</ span ></ code > .
2006-08-22 15:57:13 +00:00
Example:
</ p >
< pre class = "programlisting" >
2007-02-15 23:11:24 +00:00
< span class = "identifier" > map</ span >< span class = "special" > < </ span >< a href = "../../support/pair.html" title = "pair" >< code class = "computeroutput" >< span class = "identifier" > pair</ span ></ code ></ a >< span class = "special" > < </ span >< span class = "keyword" > int</ span >< span class = "special" > ,</ span > < span class = "keyword" > char</ span >< span class = "special" > > ,</ span > < a href = "../../support/pair.html" title = "pair" >< code class = "computeroutput" >< span class = "identifier" > pair</ span ></ code ></ a >< span class = "special" > < </ span >< span class = "keyword" > char</ span >< span class = "special" > ,</ span > < span class = "keyword" > char</ span >< span class = "special" > > ,</ span > < a href = "../../support/pair.html" title = "pair" >< code class = "computeroutput" >< span class = "identifier" > pair</ span ></ code ></ a >< span class = "special" > < </ span >< span class = "keyword" > double</ span >< span class = "special" > ,</ span > < span class = "keyword" > char</ span >< span class = "special" > > </ span > < span class = "special" > > </ span >
2006-08-22 15:57:13 +00:00
</ pre >
< p >
2007-02-15 23:11:24 +00:00
You may define the preprocessor constant < code class = "computeroutput" >< span class = "identifier" > FUSION_MAX_MAP_SIZE</ span ></ code >
2006-08-22 15:57:13 +00:00
before including any Fusion header to change the default. Example:
</ p >
< pre class = "programlisting" >
< span class = "preprocessor" > #define</ span > < span class = "identifier" > FUSION_MAX_MAP_SIZE</ span > < span class = "number" > 20</ span >
</ pre >
< a name = "fusion.sequences.containers.map.template_parameters" ></ a >< h5 >
2007-07-13 19:25:34 +00:00
< a name = "id1000695" ></ a >
2006-08-22 15:57:13 +00:00
< a href = "map.html#fusion.sequences.containers.map.template_parameters" > Template
parameters</ a >
</ h5 >
2006-10-30 01:20:23 +00:00
< div class = "informaltable" >< table class = "table" >
2006-08-22 15:57:13 +00:00
< colgroup >
< col >
< col >
< col >
</ colgroup >
< thead >< tr >
2007-07-13 19:25:34 +00:00
< th >
< p >
Parameter
</ p >
</ th >
< th >
< p >
Description
</ p >
</ th >
< th >
< p >
Default
</ p >
</ th >
2006-08-22 15:57:13 +00:00
</ tr ></ thead >
< tbody >< tr >
< td >
2007-07-13 19:25:34 +00:00
< p >
< code class = "computeroutput" >< span class = "identifier" > T0</ span ></ code > ...< code class = "computeroutput" >< span class = "identifier" > TN</ span ></ code >
</ p >
</ td >
< td >
< p >
Element types
</ p >
</ td >
< td >
< p >
< span class = "emphasis" >< em > unspecified-type</ em ></ span >
</ p >
</ td >
2006-08-22 15:57:13 +00:00
</ tr ></ tbody >
2006-10-30 01:20:23 +00:00
</ table ></ div >
2006-08-22 15:57:13 +00:00
< a name = "fusion.sequences.containers.map.model_of" ></ a >< h5 >
2007-07-13 19:25:34 +00:00
< a name = "id1000802" ></ a >
2006-08-22 15:57:13 +00:00
< a href = "map.html#fusion.sequences.containers.map.model_of" > Model of</ a >
</ h5 >
< div class = "itemizedlist" >< ul type = "disc" >
< li >< a href = "../concepts/associative_sequence.html" title = "Associative
Sequence" > Associative
Sequence</ a ></ li >
< li >< a href = "../concepts/forward_sequence.html" title = "Forward
Sequence" > Forward Sequence</ a ></ li >
</ ul ></ div >
< div class = "variablelist" >
< p class = "title" >< b > Notation</ b ></ p >
< dl >
2007-02-15 23:11:24 +00:00
< dt >< span class = "term" >< code class = "computeroutput" >< span class = "identifier" > M</ span ></ code ></ span ></ dt >
2006-08-22 15:57:13 +00:00
< dd >
2007-02-15 23:11:24 +00:00
A < code class = "computeroutput" >< span class = "identifier" > map</ span ></ code > type
2006-08-22 15:57:13 +00:00
</ dd >
2007-02-15 23:11:24 +00:00
< dt >< span class = "term" >< code class = "computeroutput" >< span class = "identifier" > m</ span ></ code ></ span ></ dt >
2006-08-22 15:57:13 +00:00
< dd >
2007-02-15 23:11:24 +00:00
An instance of < code class = "computeroutput" >< span class = "identifier" > map</ span ></ code >
2006-08-22 15:57:13 +00:00
</ dd >
2007-02-15 23:11:24 +00:00
< dt >< span class = "term" >< code class = "computeroutput" >< span class = "identifier" > e0</ span ></ code > ...< code class = "computeroutput" >< span class = "identifier" > en</ span ></ code ></ span ></ dt >
2006-08-22 15:57:13 +00:00
< dd >
2007-02-15 23:11:24 +00:00
Heterogeneous key/value pairs (see < a href = "../../support/pair.html" title = "pair" >< code class = "computeroutput" >< span class = "identifier" > fusion</ span >< span class = "special" > ::</ span >< span class = "identifier" > pair</ span ></ code ></ a > )
2006-08-22 15:57:13 +00:00
</ dd >
2007-02-15 23:11:24 +00:00
< dt >< span class = "term" >< code class = "computeroutput" >< span class = "identifier" > s</ span ></ code ></ span ></ dt >
2006-08-22 15:57:13 +00:00
< dd >
A < a href = "../concepts/forward_sequence.html" title = "Forward
Sequence" > Forward
Sequence</ a >
</ dd >
</ dl >
</ div >
< a name = "fusion.sequences.containers.map.expression_semantics" ></ a >< h5 >
2007-07-13 19:25:34 +00:00
< a name = "id1000987" ></ a >
2006-08-22 15:57:13 +00:00
< a href = "map.html#fusion.sequences.containers.map.expression_semantics" > Expression
Semantics</ a >
</ h5 >
< p >
Semantics of an expression is defined only where it differs from, or is
not defined in < a href = "../concepts/random_access_sequence.html" title = "Random
Access Sequence" > Random
Access Sequence</ a > and < a href = "../concepts/associative_sequence.html" title = "Associative
Sequence" > Associative
Sequence</ a > .
</ p >
2006-10-30 01:20:23 +00:00
< div class = "informaltable" >< table class = "table" >
2006-08-22 15:57:13 +00:00
< colgroup >
< col >
< col >
</ colgroup >
< thead >< tr >
2007-07-13 19:25:34 +00:00
< th >
< p >
Expression
</ p >
</ th >
< th >
< p >
Semantics
</ p >
</ th >
2006-08-22 15:57:13 +00:00
</ tr ></ thead >
< tbody >
< tr >
2007-07-13 19:25:34 +00:00
< td >
< p >
< code class = "computeroutput" >< span class = "identifier" > M</ span >< span class = "special" > ()</ span ></ code >
</ p >
</ td >
< td >
< p >
Creates a map with default constructed elements.
</ p >
</ td >
2006-08-22 15:57:13 +00:00
</ tr >
< tr >
2007-07-13 19:25:34 +00:00
< td >
< p >
< code class = "computeroutput" >< span class = "identifier" > M</ span >< span class = "special" > (</ span >< span class = "identifier" > e0</ span >< span class = "special" > ,</ span >
< span class = "identifier" > e1</ span >< span class = "special" > ,...</ span >
< span class = "identifier" > en</ span >< span class = "special" > )</ span ></ code >
</ p >
</ td >
< td >
< p >
Creates a map with element pairs < code class = "computeroutput" >< span class = "identifier" > e0</ span ></ code > ...< code class = "computeroutput" >< span class = "identifier" > en</ span ></ code > .
</ p >
</ td >
2006-08-22 15:57:13 +00:00
</ tr >
< tr >
2007-07-13 19:25:34 +00:00
< td >
< p >
< code class = "computeroutput" >< span class = "identifier" > M</ span >< span class = "special" > (</ span >< span class = "identifier" > s</ span >< span class = "special" > )</ span ></ code >
</ p >
</ td >
< td >
< p >
Copy constructs a map from a < a href = "../concepts/forward_sequence.html" title = "Forward
2006-08-22 15:57:13 +00:00
Sequence" > Forward
2007-07-13 19:25:34 +00:00
Sequence</ a > < code class = "computeroutput" >< span class = "identifier" > s</ span ></ code > .
</ p >
</ td >
2006-08-22 15:57:13 +00:00
</ tr >
< tr >
2007-07-13 19:25:34 +00:00
< td >
< p >
< code class = "computeroutput" >< span class = "identifier" > m</ span > < span class = "special" > =</ span >
< span class = "identifier" > s</ span ></ code >
</ p >
</ td >
< td >
< p >
Assigns to a map, < code class = "computeroutput" >< span class = "identifier" > m</ span ></ code > ,
from a < a href = "../concepts/forward_sequence.html" title = "Forward
2006-08-22 15:57:13 +00:00
Sequence" > Forward
2007-07-13 19:25:34 +00:00
Sequence</ a > < code class = "computeroutput" >< span class = "identifier" > s</ span ></ code > .
</ p >
</ td >
2006-08-22 15:57:13 +00:00
</ tr >
</ tbody >
2006-10-30 01:20:23 +00:00
</ table ></ div >
2006-08-22 15:57:13 +00:00
< a name = "fusion.sequences.containers.map.example" ></ a >< h5 >
2007-07-13 19:25:34 +00:00
< a name = "id1001298" ></ a >
2006-08-22 15:57:13 +00:00
< a href = "map.html#fusion.sequences.containers.map.example" > Example</ a >
</ h5 >
< pre class = "programlisting" >
< span class = "keyword" > typedef</ span > < span class = "identifier" > map</ span >< span class = "special" > < </ span >
2007-02-15 23:11:24 +00:00
< a href = "../../support/pair.html" title = "pair" >< code class = "computeroutput" >< span class = "identifier" > pair</ span ></ code ></ a >< span class = "special" > < </ span >< span class = "keyword" > int</ span >< span class = "special" > ,</ span > < span class = "keyword" > char</ span >< span class = "special" > > </ span >
2007-07-13 19:25:34 +00:00
< span class = "special" > ,</ span > < a href = "../../support/pair.html" title = "pair" >< code class = "computeroutput" >< span class = "identifier" > pair</ span ></ code ></ a >< span class = "special" > < </ span >< span class = "keyword" > double</ span >< span class = "special" > ,</ span > < span class = "identifier" > std</ span >< span class = "special" > ::</ span >< span class = "identifier" > string</ span >< span class = "special" > > </ span > < span class = "special" > > </ span >
2006-08-22 15:57:13 +00:00
< span class = "identifier" > map_type</ span >< span class = "special" > ;</ span >
< span class = "identifier" > map_type</ span > < span class = "identifier" > m</ span >< span class = "special" > (</ span >
2007-02-15 23:11:24 +00:00
< a href = "../../support/pair.html" title = "pair" >< code class = "computeroutput" >< span class = "identifier" > make_pair</ span ></ code ></ a >< span class = "special" > < </ span >< span class = "keyword" > int</ span >< span class = "special" > > (</ span >< span class = "char" > 'X'</ span >< span class = "special" > )</ span >
< span class = "special" > ,</ span > < a href = "../../support/pair.html" title = "pair" >< code class = "computeroutput" >< span class = "identifier" > make_pair</ span ></ code ></ a >< span class = "special" > < </ span >< span class = "keyword" > double</ span >< span class = "special" > > (</ span >< span class = "string" > "Men"</ span >< span class = "special" > ));</ span >
2006-08-22 15:57:13 +00:00
2007-07-13 19:25:34 +00:00
< span class = "identifier" > std</ span >< span class = "special" > ::</ span >< span class = "identifier" > cout</ span > < span class = "special" > << </ span > < a href = "../intrinsics/functions/at_key.html" title = "at_key" >< code class = "computeroutput" >< span class = "identifier" > at_key</ span ></ code ></ a >< span class = "special" > < </ span >< span class = "keyword" > int</ span >< span class = "special" > > (</ span >< span class = "identifier" > m</ span >< span class = "special" > )</ span > < span class = "special" > << </ span > < span class = "identifier" > std</ span >< span class = "special" > ::</ span >< span class = "identifier" > endl</ span >< span class = "special" > ;</ span >
< span class = "identifier" > std</ span >< span class = "special" > ::</ span >< span class = "identifier" > cout</ span > < span class = "special" > << </ span > < a href = "../intrinsics/functions/at_key.html" title = "at_key" >< code class = "computeroutput" >< span class = "identifier" > at_key</ span ></ code ></ a >< span class = "special" > < </ span >< span class = "keyword" > double</ span >< span class = "special" > > (</ span >< span class = "identifier" > m</ span >< span class = "special" > )</ span > < span class = "special" > << </ span > < span class = "identifier" > std</ span >< span class = "special" > ::</ span >< span class = "identifier" > endl</ span >< span class = "special" > ;</ span >
2006-08-22 15:57:13 +00:00
</ pre >
</ div >
< table xmlns:rev = "http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width = "100%" >< tr >
< td align = "left" ></ td >
2007-02-25 22:02:27 +00:00
< td align = "right" >< small > Copyright © 2001-2007 Joel de Guzman, Dan Marsden, Tobias
Schwinger</ small ></ td >
2006-08-22 15:57:13 +00:00
</ tr ></ table >
< hr >
< div class = "spirit-nav" >
< a accesskey = "p" href = "set.html" >< img src = "../../../images/prev.png" alt = "Prev" ></ a >< a accesskey = "u" href = "../containers.html" >< img src = "../../../images/up.png" alt = "Up" ></ a >< a accesskey = "h" href = "../../../index.html" >< img src = "../../../images/home.png" alt = "Home" ></ a >< a accesskey = "n" href = "../views.html" >< img src = "../../../images/next.png" alt = "Next" ></ a >
</ div >
</ body >
</ html >
