2007-11-06 12:13:52 +00:00
< html >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=ISO-8859-1" >
< title > map</ title >
2007-11-07 16:22:38 +00:00
< link rel = "stylesheet" href = "../../../../../../doc/html/boostbook.css" type = "text/css" >
2007-11-06 12:13:52 +00:00
< meta name = "generator" content = "DocBook XSL Stylesheets V1.66.1" >
< link rel = "start" href = "../../index.html" title = "Chapter >
< link rel = "up" href = "../container.html" title = "Container" >
< link rel = "prev" href = "set.html" title = "set" >
< link rel = "next" href = "generation.html" title = "Generation" >
</ head >
< body bgcolor = "white" text = "black" link = "#0000FF" vlink = "#840084" alink = "#0000FF" >
< table cellpadding = "2" width = "100%" >< tr >
< 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 >
</ tr ></ table >
< hr >
< div class = "spirit-nav" >
< a accesskey = "p" href = "set.html" >< img src = "../../../../../../doc/html/images/prev.png" alt = "Prev" ></ a >< a accesskey = "u" href = "../container.html" >< img src = "../../../../../../doc/html/images/up.png" alt = "Up" ></ a >< a accesskey = "h" href = "../../index.html" >< img src = "../../../../../../doc/html/images/home.png" alt = "Home" ></ a >< a accesskey = "n" href = "generation.html" >< img src = "../../../../../../doc/html/images/next.png" alt = "Next" ></ a >
</ div >
< div class = "section" lang = "en" >
< div class = "titlepage" >< div >< div >< h3 class = "title" >
< a name = "fusion.container.map" ></ a >< a href = "map.html" title = "map" > map</ a ></ h3 ></ div ></ div ></ div >
< a name = "fusion.container.map.description" ></ a >< h4 >
2007-12-19 22:46:16 +00:00
< a name = "id536066" ></ a >
2007-11-06 12:13:52 +00:00
< a href = "map.html#fusion.container.map.description" > Description</ a >
</ h4 >
< p >
map is an < a href = "../sequence/concepts/associative_sequence.html" title = "Associative
Sequence" > Associative
Sequence</ a > of heteregenous typed data elements. Each element is a key/data
pair (see < a href = "../support/pair.html" title = "pair" >< tt class = "computeroutput" >< span class = "identifier" > fusion</ span >< span class = "special" > ::</ span >< span class = "identifier" > pair</ span ></ tt ></ a > )
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.container.map.header" ></ a >< h4 >
2007-12-19 22:46:16 +00:00
< a name = "id536147" ></ a >
2007-11-06 12:13:52 +00:00
< a href = "map.html#fusion.container.map.header" > Header</ a >
</ h4 >
< 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" > container</ span >< span class = "special" > /</ span >< span class = "identifier" > map</ span >< span class = "special" > .</ span >< span class = "identifier" > hpp</ span >< span class = "special" > > </ span >
< 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" > include</ span >< span class = "special" > /</ span >< span class = "identifier" > map</ span >< span class = "special" > .</ span >< span class = "identifier" > hpp</ span >< span class = "special" > > </ span >
< 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" > container</ span >< span class = "special" > /</ span >< span class = "identifier" > map_fwd</ span >< span class = "special" > .</ span >< span class = "identifier" > hpp</ span >< span class = "special" > > </ span >
< 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" > include</ span >< span class = "special" > /</ span >< span class = "identifier" > map_fwd</ span >< span class = "special" > .</ span >< span class = "identifier" > hpp</ span >< span class = "special" > > </ span >
</ pre >
< a name = "fusion.container.map.synopsis" ></ a >< h4 >
2007-12-19 22:46:16 +00:00
< a name = "id536429" ></ a >
2007-11-06 12:13:52 +00:00
< a href = "map.html#fusion.container.map.synopsis" > Synopsis</ a >
</ h4 >
< 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 >
The variadic class interface accepts < tt class = "computeroutput" >< span class = "number" > 0</ span ></ tt >
to < tt class = "computeroutput" >< span class = "identifier" > FUSION_MAX_MAP_SIZE</ span ></ tt > elements,
where < tt class = "computeroutput" >< span class = "identifier" > FUSION_MAX_MAP_SIZE</ span ></ tt >
is a user definable predefined maximum that defaults to < tt class = "computeroutput" >< span class = "number" > 10</ span ></ tt > .
Example:
</ p >
< pre class = "programlisting" >
< span class = "identifier" > map</ span >< span class = "special" > < </ span >< a href = "../support/pair.html" title = "pair" >< tt class = "computeroutput" >< span class = "identifier" > pair</ span ></ tt ></ 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" >< tt class = "computeroutput" >< span class = "identifier" > pair</ span ></ tt ></ 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" >< tt class = "computeroutput" >< span class = "identifier" > pair</ span ></ tt ></ 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 >
</ pre >
< p >
You may define the preprocessor constant < tt class = "computeroutput" >< span class = "identifier" > FUSION_MAX_MAP_SIZE</ span ></ tt >
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.container.map.template_parameters" ></ a >< h4 >
2007-12-19 22:46:16 +00:00
< a name = "id536859" ></ a >
2007-11-06 12:13:52 +00:00
< a href = "map.html#fusion.container.map.template_parameters" > Template parameters</ a >
</ h4 >
< div class = "informaltable" >< table class = "table" >
< colgroup >
< col >
< col >
< col >
</ colgroup >
< thead >< tr >
< th >
< p >
Parameter
</ p >
</ th >
< th >
< p >
Description
</ p >
</ th >
< th >
< p >
Default
</ p >
</ th >
</ tr ></ thead >
< tbody >< tr >
< td >
< p >
< tt class = "computeroutput" >< span class = "identifier" > T0</ span ></ tt > ...< tt class = "computeroutput" >< span class = "identifier" > TN</ span ></ tt >
</ p >
</ td >
< td >
< p >
Element types
</ p >
</ td >
< td >
< p >
< span class = "emphasis" >< em > unspecified-type</ em ></ span >
</ p >
</ td >
</ tr ></ tbody >
</ table ></ div >
< a name = "fusion.container.map.model_of" ></ a >< h4 >
2007-12-19 22:46:16 +00:00
< a name = "id536978" ></ a >
2007-11-06 12:13:52 +00:00
< a href = "map.html#fusion.container.map.model_of" > Model of</ a >
</ h4 >
< div class = "itemizedlist" >< ul type = "disc" >
< li >< a href = "../sequence/concepts/associative_sequence.html" title = "Associative
Sequence" > Associative
Sequence</ a ></ li >
< li >< a href = "../sequence/concepts/forward_sequence.html" title = "Forward
Sequence" > Forward Sequence</ a ></ li >
</ ul ></ div >
< div class = "variablelist" >
< p class = "title" >< b > Notation</ b ></ p >
< dl >
< dt >< span class = "term" >< tt class = "computeroutput" >< span class = "identifier" > M</ span ></ tt ></ span ></ dt >
< dd >< p >
A < tt class = "computeroutput" >< span class = "identifier" > map</ span ></ tt > type
</ p ></ dd >
< dt >< span class = "term" >< tt class = "computeroutput" >< span class = "identifier" > m</ span ></ tt ></ span ></ dt >
< dd >< p >
An instance of < tt class = "computeroutput" >< span class = "identifier" > map</ span ></ tt >
</ p ></ dd >
< dt >< span class = "term" >< tt class = "computeroutput" >< span class = "identifier" > e0</ span ></ tt > ...< tt class = "computeroutput" >< span class = "identifier" > en</ span ></ tt ></ span ></ dt >
< dd >< p >
Heterogeneous key/value pairs (see < a href = "../support/pair.html" title = "pair" >< tt class = "computeroutput" >< span class = "identifier" > fusion</ span >< span class = "special" > ::</ span >< span class = "identifier" > pair</ span ></ tt ></ a > )
</ p ></ dd >
< dt >< span class = "term" >< tt class = "computeroutput" >< span class = "identifier" > s</ span ></ tt ></ span ></ dt >
< dd >< p >
A < a href = "../sequence/concepts/forward_sequence.html" title = "Forward
Sequence" > Forward Sequence</ a >
</ p ></ dd >
</ dl >
</ div >
< a name = "fusion.container.map.expression_semantics" ></ a >< h4 >
2007-12-19 22:46:16 +00:00
< a name = "id537201" ></ a >
2007-11-06 12:13:52 +00:00
< a href = "map.html#fusion.container.map.expression_semantics" > Expression Semantics</ a >
</ h4 >
< p >
Semantics of an expression is defined only where it differs from, or is not
defined in < a href = "../sequence/concepts/random_access_sequence.html" title = "Random
Access Sequence" > Random
Access Sequence</ a > and < a href = "../sequence/concepts/associative_sequence.html" title = "Associative
Sequence" > Associative
Sequence</ a > .
</ p >
< div class = "informaltable" >< table class = "table" >
< colgroup >
< col >
< col >
</ colgroup >
< thead >< tr >
< th >
< p >
Expression
</ p >
</ th >
< th >
< p >
Semantics
</ p >
</ th >
</ tr ></ thead >
< tbody >
< tr >
< td >
< p >
< tt class = "computeroutput" >< span class = "identifier" > M</ span >< span class = "special" > ()</ span ></ tt >
</ p >
</ td >
< td >
< p >
Creates a map with default constructed elements.
</ p >
</ td >
</ tr >
< tr >
< td >
< p >
< tt 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 ></ tt >
</ p >
</ td >
< td >
< p >
Creates a map with element pairs < tt class = "computeroutput" >< span class = "identifier" > e0</ span ></ tt > ...< tt class = "computeroutput" >< span class = "identifier" > en</ span ></ tt > .
</ p >
</ td >
</ tr >
< tr >
< td >
< p >
< tt class = "computeroutput" >< span class = "identifier" > M</ span >< span class = "special" > (</ span >< span class = "identifier" > s</ span >< span class = "special" > )</ span ></ tt >
</ p >
</ td >
< td >
< p >
Copy constructs a map from a < a href = "../sequence/concepts/forward_sequence.html" title = "Forward
Sequence" > Forward
Sequence</ a > < tt class = "computeroutput" >< span class = "identifier" > s</ span ></ tt > .
</ p >
</ td >
</ tr >
< tr >
< td >
< p >
< tt class = "computeroutput" >< span class = "identifier" > m</ span > < span class = "special" > =</ span >
< span class = "identifier" > s</ span ></ tt >
</ p >
</ td >
< td >
< p >
Assigns to a map, < tt class = "computeroutput" >< span class = "identifier" > m</ span ></ tt > ,
from a < a href = "../sequence/concepts/forward_sequence.html" title = "Forward
Sequence" > Forward
Sequence</ a > < tt class = "computeroutput" >< span class = "identifier" > s</ span ></ tt > .
</ p >
</ td >
</ tr >
</ tbody >
</ table ></ div >
< a name = "fusion.container.map.example" ></ a >< h4 >
2007-12-19 22:46:16 +00:00
< a name = "id537549" ></ a >
2007-11-06 12:13:52 +00:00
< a href = "map.html#fusion.container.map.example" > Example</ a >
</ h4 >
< pre class = "programlisting" >
< span class = "keyword" > typedef</ span > < span class = "identifier" > map</ span >< span class = "special" > < </ span >
< a href = "../support/pair.html" title = "pair" >< tt class = "computeroutput" >< span class = "identifier" > pair</ span ></ tt ></ a >< span class = "special" > < </ span >< span class = "keyword" > int</ span >< span class = "special" > ,</ span > < span class = "keyword" > char</ span >< span class = "special" > > </ span >
< span class = "special" > ,</ span > < a href = "../support/pair.html" title = "pair" >< tt class = "computeroutput" >< span class = "identifier" > pair</ span ></ tt ></ 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 >
< 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 >
< a href = "../support/pair.html" title = "pair" >< tt class = "computeroutput" >< span class = "identifier" > make_pair</ span ></ tt ></ 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" >< tt class = "computeroutput" >< span class = "identifier" > make_pair</ span ></ tt ></ a >< span class = "special" > < </ span >< span class = "keyword" > double</ span >< span class = "special" > > (</ span >< span class = "string" > "Men"</ 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 = "../sequence/intrinsic/functions/at_key.html" title = "at_key" >< tt class = "computeroutput" >< span class = "identifier" > at_key</ span ></ tt ></ 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 = "../sequence/intrinsic/functions/at_key.html" title = "at_key" >< tt class = "computeroutput" >< span class = "identifier" > at_key</ span ></ tt ></ 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 >
</ pre >
</ div >
< table xmlns:rev = "http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width = "100%" >< tr >
< td align = "left" ></ td >
2007-11-16 08:03:15 +00:00
< td align = "right" >< div class = "copyright-footer" > Copyright © 2001-2007 Joel de Guzman, Dan Marsden, Tobias
2007-11-07 16:22:38 +00:00
Schwinger< p >
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at < a href = "http://www.boost.org/LICENSE_1_0.txt" target = "_top" > http://www.boost.org/LICENSE_1_0.txt</ a > )
2007-11-16 08:03:15 +00:00
</ p >
</ div ></ td >
2007-11-06 12:13:52 +00:00
</ tr ></ table >
< hr >
< div class = "spirit-nav" >
< a accesskey = "p" href = "set.html" >< img src = "../../../../../../doc/html/images/prev.png" alt = "Prev" ></ a >< a accesskey = "u" href = "../container.html" >< img src = "../../../../../../doc/html/images/up.png" alt = "Up" ></ a >< a accesskey = "h" href = "../../index.html" >< img src = "../../../../../../doc/html/images/home.png" alt = "Home" ></ a >< a accesskey = "n" href = "generation.html" >< img src = "../../../../../../doc/html/images/next.png" alt = "Next" ></ a >
</ div >
</ body >
</ html >
