2007-11-25 18:38:02 +00:00
< html >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=ISO-8859-1" >
2009-10-11 16:12:54 +00:00
< title > Associative
Sequence</ title >
2007-11-25 18:38:02 +00:00
< link rel = "stylesheet" href = "../../../../../../../doc/html/boostbook.css" type = "text/css" >
2010-01-01 22:00:21 +00:00
<<<<<< < .working
2009-10-11 16:12:54 +00:00
< meta name = "generator" content = "DocBook XSL Stylesheets V1.65.1" >
2010-01-01 22:00:21 +00:00
=======
< meta name = "generator" content = "DocBook XSL Stylesheets V1.75.1" >
>>>>>>> .merge-right.r57125
2009-09-14 07:47:53 +00:00
< link rel = "home" href = "../../../index.html" title = "Chapter >
2007-11-25 18:38:02 +00:00
< link rel = "up" href = "../concepts.html" title = "Concepts" >
2009-10-11 16:12:54 +00:00
< link rel = "previous" href = "random_access_sequence.html" title = "Random
Access Sequence" >
2007-11-25 18:38:02 +00:00
< link rel = "next" href = "../intrinsic.html" title = "Intrinsic" >
</ 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 >
2008-07-17 23:59:40 +00:00
< td align = "center" >< a href = "../../../../../../../index.html" > Home</ a ></ td >
2007-11-25 18:38:02 +00:00
< td align = "center" >< a href = "../../../../../../libraries.htm" > Libraries</ a ></ td >
2008-07-17 23:59:40 +00:00
< td align = "center" >< a href = "http://www.boost.org/users/people.html" > People</ a ></ td >
< td align = "center" >< a href = "http://www.boost.org/users/faq.html" > FAQ</ a ></ td >
2007-11-25 18:38:02 +00:00
< td align = "center" >< a href = "../../../../../../../more/index.htm" > More</ a ></ td >
</ tr ></ table >
< hr >
< div class = "spirit-nav" >
< a accesskey = "p" href = "random_access_sequence.html" >< img src = "../../../../../../../doc/html/images/prev.png" alt = "Prev" ></ a >< a accesskey = "u" href = "../concepts.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 = "../intrinsic.html" >< img src = "../../../../../../../doc/html/images/next.png" alt = "Next" ></ a >
</ div >
2009-10-11 16:12:54 +00:00
< div class = "section" lang = "en" >
< div class = "titlepage" >
< div >< div >< h4 class = "title" >
< a name = "fusion.sequence.concepts.associative_sequence" ></ a >< a href = "associative_sequence.html" title = "Associative
Sequence" > Associative
2009-09-14 07:47:53 +00:00
Sequence</ a >
2010-01-01 22:00:21 +00:00
<<<<<< < .working
2009-10-11 16:12:54 +00:00
</ h4 ></ div ></ div >
< div ></ div >
</ div >
< a name = "fusion.sequence.concepts.associative_sequence.description" ></ a >< h5 >
< a name = "id447542" ></ a >
< a href = "associative_sequence.html#fusion.sequence.concepts.associative_sequence.description" > Description</ a >
</ h5 >
2010-01-01 22:00:21 +00:00
=======
</ h4 ></ div ></ div ></ div >
< a name = "fusion.sequence.concepts.associative_sequence.description" ></ a >< h6 >
< a name = "id651268" ></ a >
< a class = "link" href = "associative_sequence.html#fusion.sequence.concepts.associative_sequence.description" > Description</ a >
</ h6 >
>>>>>>> .merge-right.r57125
2007-11-25 18:38:02 +00:00
< p >
An Associative Sequence allows efficient retrieval of elements based on
keys. Like associative sequences in < a href = "http://www.boost.org/libs/mpl/index.html" target = "_top" > MPL</ a > ,
and unlike associative containers in < a href = "http://en.wikipedia.org/wiki/Standard_Template_Library" target = "_top" > STL</ a > ,
Fusion associative sequences have no implied ordering relation. Instead,
2010-01-01 22:00:21 +00:00
type identity is used to impose an equivalence relation on keys.
2007-11-25 18:38:02 +00:00
</ p >
2009-10-11 16:12:54 +00:00
< div class = "variablelist" >
2007-11-25 18:38:02 +00:00
< p class = "title" >< b > Notation</ b ></ p >
< dl >
2009-10-11 16:12:54 +00:00
< dt >< span class = "term" >< tt class = "computeroutput" >< span class = "identifier" > s</ span ></ tt ></ span ></ dt >
2007-11-25 18:38:02 +00:00
< dd >< p >
An Associative Sequence
</ p ></ dd >
2009-10-11 16:12:54 +00:00
< dt >< span class = "term" >< tt class = "computeroutput" >< span class = "identifier" > S</ span ></ tt ></ span ></ dt >
2007-11-25 18:38:02 +00:00
< dd >< p >
An Associative Sequence type
</ p ></ dd >
2009-10-11 16:12:54 +00:00
< dt >< span class = "term" >< tt class = "computeroutput" >< span class = "identifier" > K</ span ></ tt ></ span ></ dt >
2007-11-25 18:38:02 +00:00
< dd >< p >
An arbitrary < span class = "emphasis" >< em > key</ em ></ span > type
</ p ></ dd >
2009-10-11 16:12:54 +00:00
< dt >< span class = "term" >< tt class = "computeroutput" >< span class = "identifier" > o</ span ></ tt ></ span ></ dt >
2007-11-25 18:38:02 +00:00
< dd >< p >
An arbitrary object
</ p ></ dd >
2009-10-11 16:12:54 +00:00
< dt >< span class = "term" >< tt class = "computeroutput" >< span class = "identifier" > e</ span ></ tt ></ span ></ dt >
2007-11-25 18:38:02 +00:00
< dd >< p >
A Sequence element
</ p ></ dd >
</ dl >
</ div >
2010-01-01 22:00:21 +00:00
<<<<<< < .working
2009-10-11 16:12:54 +00:00
< a name = "fusion.sequence.concepts.associative_sequence.valid_expressions" ></ a >< h5 >
< a name = "id447735" ></ a >
< a href = "associative_sequence.html#fusion.sequence.concepts.associative_sequence.valid_expressions" > Valid
2010-01-01 22:00:21 +00:00
=======
< a name = "fusion.sequence.concepts.associative_sequence.valid_expressions" ></ a >< h6 >
< a name = "id651402" ></ a >
< a class = "link" href = "associative_sequence.html#fusion.sequence.concepts.associative_sequence.valid_expressions" > Valid
>>>>>>> .merge-right.r57125
2007-11-25 18:38:02 +00:00
Expressions</ a >
2009-10-11 16:12:54 +00:00
</ h5 >
2007-11-25 18:38:02 +00:00
< p >
For any Associative Sequence the following expressions must be valid:
</ p >
< div class = "informaltable" >< table class = "table" >
< colgroup >
< col >
< col >
< col >
< col >
</ colgroup >
< thead >< tr >
2009-10-11 16:12:54 +00:00
< th >< p >
2007-11-25 18:38:02 +00:00
Expression
2009-10-11 16:12:54 +00:00
</ p ></ th >
< th >< p >
2007-11-25 18:38:02 +00:00
Return type
2009-10-11 16:12:54 +00:00
</ p ></ th >
< th >< p >
2007-11-25 18:38:02 +00:00
Type Requirements
2009-10-11 16:12:54 +00:00
</ p ></ th >
< th >< p >
2007-11-25 18:38:02 +00:00
Runtime Complexity
2009-10-11 16:12:54 +00:00
</ p ></ th >
2007-11-25 18:38:02 +00:00
</ tr ></ thead >
< tbody >
< tr >
2009-10-11 16:12:54 +00:00
< td >< p >
< tt class = "computeroutput" >< a href = "../intrinsic/functions/has_key.html" title = "has_key" >< tt class = "computeroutput" >< span class = "identifier" > has_key</ span ></ tt ></ a >< span class = "special" > < </ span >< span class = "identifier" > K</ span >< span class = "special" > > (</ span >< span class = "identifier" > s</ span >< span class = "special" > )</ span ></ tt >
</ p ></ td >
< td >< p >
2007-11-25 18:38:02 +00:00
< a href = "http://www.boost.org/libs/mpl/doc/refmanual/integral-constant.html" target = "_top" > MPL
Boolean Constant</ a > . Convertible to bool.
2009-10-11 16:12:54 +00:00
</ p ></ td >
< td >< p >
</ p ></ td >
< td >< p >
2007-11-25 18:38:02 +00:00
Constant
2009-10-11 16:12:54 +00:00
</ p ></ td >
2007-11-25 18:38:02 +00:00
</ tr >
< tr >
2009-10-11 16:12:54 +00:00
< td >< p >
< tt class = "computeroutput" >< a href = "../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 = "identifier" > K</ span >< span class = "special" > > (</ span >< span class = "identifier" > s</ span >< span class = "special" > )</ span ></ tt >
</ p ></ td >
< td >< p >
2007-11-25 18:38:02 +00:00
Any type
2009-10-11 16:12:54 +00:00
</ p ></ td >
< td >< p >
</ p ></ td >
< td >< p >
2007-11-25 18:38:02 +00:00
Constant
2009-10-11 16:12:54 +00:00
</ p ></ td >
2007-11-25 18:38:02 +00:00
</ tr >
< tr >
2009-10-11 16:12:54 +00:00
< td >< p >
< tt class = "computeroutput" >< a href = "../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 = "identifier" > K</ span >< span class = "special" > > (</ span >< span class = "identifier" > s</ span >< span class = "special" > )</ span >
< span class = "special" > =</ span > < span class = "identifier" > o</ span ></ tt >
</ p ></ td >
< td >< p >
2007-11-25 18:38:02 +00:00
Any type
2009-10-11 16:12:54 +00:00
</ p ></ td >
< td >< p >
< tt class = "computeroutput" >< span class = "identifier" > s</ span ></ tt > is mutable and
< tt class = "computeroutput" >< span class = "identifier" > e</ span > < span class = "special" > =</ span >
< span class = "identifier" > o</ span ></ tt > , where < tt class = "computeroutput" >< span class = "identifier" > e</ span ></ tt > is the first element in the
2007-11-25 18:38:02 +00:00
sequence, is a valid expression.
2009-10-11 16:12:54 +00:00
</ p ></ td >
< td >< p >
2007-11-25 18:38:02 +00:00
Constant
2009-10-11 16:12:54 +00:00
</ p ></ td >
2007-11-25 18:38:02 +00:00
</ tr >
</ tbody >
</ table ></ div >
2010-01-01 22:00:21 +00:00
<<<<<< < .working
2009-10-11 16:12:54 +00:00
< a name = "fusion.sequence.concepts.associative_sequence.result_type_expressions" ></ a >< h5 >
< a name = "id448116" ></ a >
< a href = "associative_sequence.html#fusion.sequence.concepts.associative_sequence.result_type_expressions" > Result
2010-01-01 22:00:21 +00:00
=======
< a name = "fusion.sequence.concepts.associative_sequence.result_type_expressions" ></ a >< h6 >
< a name = "id651688" ></ a >
< a class = "link" href = "associative_sequence.html#fusion.sequence.concepts.associative_sequence.result_type_expressions" > Result
>>>>>>> .merge-right.r57125
2007-11-25 18:38:02 +00:00
Type Expressions</ a >
2009-10-11 16:12:54 +00:00
</ h5 >
2007-11-25 18:38:02 +00:00
< div class = "informaltable" >< table class = "table" >
< colgroup >
< col >
< col >
</ colgroup >
< thead >< tr >
2009-10-11 16:12:54 +00:00
< th >< p >
2007-11-25 18:38:02 +00:00
Expression
2009-10-11 16:12:54 +00:00
</ p ></ th >
< th >< p >
2007-11-25 18:38:02 +00:00
Compile Time Complexity
2009-10-11 16:12:54 +00:00
</ p ></ th >
2007-11-25 18:38:02 +00:00
</ tr ></ thead >
< tbody >
< tr >
2009-10-11 16:12:54 +00:00
< td >< p >
< tt class = "computeroutput" >< a href = "../intrinsic/metafunctions/has_key.html" title = "has_key" >< tt class = "computeroutput" >< span class = "identifier" > result_of</ span >< span class = "special" > ::</ span >< span class = "identifier" > has_key</ span ></ tt ></ a >< span class = "special" > < </ span >< span class = "identifier" > S</ span >< span class = "special" > ,</ span >
< span class = "identifier" > K</ span >< span class = "special" > > ::</ span >< span class = "identifier" > type</ span ></ tt >
</ p ></ td >
< td >< p >
2007-11-25 18:38:02 +00:00
Amortized constant time
2009-10-11 16:12:54 +00:00
</ p ></ td >
2007-11-25 18:38:02 +00:00
</ tr >
< tr >
2009-10-11 16:12:54 +00:00
< td >< p >
< tt class = "computeroutput" >< a href = "../intrinsic/metafunctions/at_key.html" title = "at_key" >< tt class = "computeroutput" >< span class = "identifier" > result_of</ span >< span class = "special" > ::</ span >< span class = "identifier" > at_key</ span ></ tt ></ a >< span class = "special" > < </ span >< span class = "identifier" > S</ span >< span class = "special" > ,</ span >
< span class = "identifier" > K</ span >< span class = "special" > > ::</ span >< span class = "identifier" > type</ span ></ tt >
</ p ></ td >
< td >< p >
2007-11-25 18:38:02 +00:00
Amortized constant time
2009-10-11 16:12:54 +00:00
</ p ></ td >
2007-11-25 18:38:02 +00:00
</ tr >
< tr >
2009-10-11 16:12:54 +00:00
< td >< p >
< tt class = "computeroutput" >< a href = "../intrinsic/metafunctions/value_at_key.html" title = "value_at_key" >< tt class = "computeroutput" >< span class = "identifier" > result_of</ span >< span class = "special" > ::</ span >< span class = "identifier" > value_at_key</ span ></ tt ></ a >< span class = "special" > < </ span >< span class = "identifier" > S</ span >< span class = "special" > ,</ span >
< span class = "identifier" > K</ span >< span class = "special" > > ::</ span >< span class = "identifier" > type</ span ></ tt >
</ p ></ td >
< td >< p >
2007-11-25 18:38:02 +00:00
Amortized constant time
2009-10-11 16:12:54 +00:00
</ p ></ td >
2007-11-25 18:38:02 +00:00
</ tr >
</ tbody >
</ table ></ div >
2009-10-11 16:12:54 +00:00
< div class = "sidebar" >< p >
< span class = "inlinemediaobject" >< img src = "images/note.png" alt = "note" ></ span > < tt class = "computeroutput" >< a href = "../intrinsic/metafunctions/at_key.html" title = "at_key" >< tt class = "computeroutput" >< span class = "identifier" > result_of</ span >< span class = "special" > ::</ span >< span class = "identifier" > at_key</ span ></ tt ></ a >< span class = "special" > < </ span >< span class = "identifier" > S</ span >< span class = "special" > ,</ span > < span class = "identifier" > K</ span >< span class = "special" > > </ span ></ tt > returns the actual type returned by
< tt class = "computeroutput" >< a href = "../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 = "identifier" > K</ span >< span class = "special" > > (</ span >< span class = "identifier" > s</ span >< span class = "special" > )</ span ></ tt > . In
2007-11-25 18:38:02 +00:00
most cases, this is a reference. Hence, there is no way to know the exact
2009-10-11 16:12:54 +00:00
element type using < tt class = "computeroutput" >< a href = "../intrinsic/metafunctions/at_key.html" title = "at_key" >< tt class = "computeroutput" >< span class = "identifier" > result_of</ span >< span class = "special" > ::</ span >< span class = "identifier" > at_key</ span ></ tt ></ a >< span class = "special" > < </ span >< span class = "identifier" > S</ span >< span class = "special" > ,</ span > < span class = "identifier" > K</ span >< span class = "special" > > </ span ></ tt > .The element at < tt class = "computeroutput" >< span class = "identifier" > K</ span ></ tt >
2007-11-25 18:38:02 +00:00
may actually be a reference to begin with. For this purpose, you can use
2010-01-01 22:00:21 +00:00
<<<<<< < .working
2009-10-11 16:12:54 +00:00
< tt class = "computeroutput" >< a href = "../intrinsic/metafunctions/value_at_key.html" title = "value_at_key" >< tt class = "computeroutput" >< span class = "identifier" > result_of</ span >< span class = "special" > ::</ span >< span class = "identifier" > value_at_key</ span ></ tt ></ a >< span class = "special" > < </ span >< span class = "identifier" > S</ span >< span class = "special" > ,</ span > < span class = "identifier" > N</ span >< span class = "special" > > </ span ></ tt > .
</ p ></ div >
< a name = "fusion.sequence.concepts.associative_sequence.expression_semantics" ></ a >< h5 >
< a name = "id448687" ></ a >
< a href = "associative_sequence.html#fusion.sequence.concepts.associative_sequence.expression_semantics" > Expression
2010-01-01 22:00:21 +00:00
=======
< code class = "computeroutput" >< a class = "link" href = "../intrinsic/metafunctions/value_at_key.html" title = "value_at_key" >< code class = "computeroutput" >< span class = "identifier" > result_of</ span >< span class = "special" > ::</ span >< span class = "identifier" > value_at_key</ span ></ code ></ a >< span class = "special" > < </ span >< span class = "identifier" > S</ span >< span class = "special" > ,</ span > < span class = "identifier" > N</ span >< span class = "special" > > </ span ></ code > .
</ p >
</ div >
< a name = "fusion.sequence.concepts.associative_sequence.expression_semantics" ></ a >< h6 >
< a name = "id652092" ></ a >
< a class = "link" href = "associative_sequence.html#fusion.sequence.concepts.associative_sequence.expression_semantics" > Expression
>>>>>>> .merge-right.r57125
2007-11-25 18:38:02 +00:00
Semantics</ a >
2009-10-11 16:12:54 +00:00
</ h5 >
2007-11-25 18:38:02 +00:00
< div class = "informaltable" >< table class = "table" >
< colgroup >
< col >
< col >
</ colgroup >
< thead >< tr >
2009-10-11 16:12:54 +00:00
< th >< p >
2007-11-25 18:38:02 +00:00
Expression
2009-10-11 16:12:54 +00:00
</ p ></ th >
< th >< p >
2007-11-25 18:38:02 +00:00
Semantics
2009-10-11 16:12:54 +00:00
</ p ></ th >
2007-11-25 18:38:02 +00:00
</ tr ></ thead >
< tbody >
< tr >
2009-10-11 16:12:54 +00:00
< td >< p >
< tt class = "computeroutput" >< a href = "../intrinsic/functions/has_key.html" title = "has_key" >< tt class = "computeroutput" >< span class = "identifier" > has_key</ span ></ tt ></ a >< span class = "special" > < </ span >< span class = "identifier" > K</ span >< span class = "special" > > (</ span >< span class = "identifier" > s</ span >< span class = "special" > )</ span ></ tt >
</ p ></ td >
< td >< p >
A boolean Integral Constant < tt class = "computeroutput" >< span class = "identifier" > c</ span ></ tt >
such that < tt class = "computeroutput" >< span class = "identifier" > c</ span >< span class = "special" > ::</ span >< span class = "identifier" > value</ span > < span class = "special" > ==</ span >
< span class = "keyword" > true</ span ></ tt > if and only if there
is one or more elements with the key < tt class = "computeroutput" >< span class = "identifier" > k</ span ></ tt >
in < tt class = "computeroutput" >< span class = "identifier" > s</ span ></ tt > ; see < a href = "../intrinsic/functions/has_key.html" title = "has_key" >< tt class = "computeroutput" >< span class = "identifier" > has_key</ span ></ tt ></ a > .
</ p ></ td >
2007-11-25 18:38:02 +00:00
</ tr >
< tr >
2009-10-11 16:12:54 +00:00
< td >< p >
< tt class = "computeroutput" >< a href = "../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 = "identifier" > K</ span >< span class = "special" > > (</ span >< span class = "identifier" > s</ span >< span class = "special" > )</ span ></ tt >
</ p ></ td >
< td >< p >
The element associated with the key < tt class = "computeroutput" >< span class = "identifier" > K</ span ></ tt >
in the sequence < tt class = "computeroutput" >< span class = "identifier" > s</ span ></ tt > ;
see < a href = "../intrinsic/functions/at.html" title = "at" >< tt class = "computeroutput" >< span class = "identifier" > at</ span ></ tt ></ a > .
</ p ></ td >
2007-11-25 18:38:02 +00:00
</ tr >
</ tbody >
</ table ></ div >
2010-01-01 22:00:21 +00:00
<<<<<< < .working
2009-10-11 16:12:54 +00:00
< a name = "fusion.sequence.concepts.associative_sequence.models" ></ a >< h5 >
< a name = "id449008" ></ a >
< a href = "associative_sequence.html#fusion.sequence.concepts.associative_sequence.models" > Models</ a >
</ h5 >
< div class = "itemizedlist" >< ul type = "disc" >
< li >< a href = "../../container/set.html" title = "set" >< tt class = "computeroutput" >< span class = "identifier" > set</ span ></ tt ></ a ></ li >
< li >< a href = "../../container/map.html" title = "map" >< tt class = "computeroutput" >< span class = "identifier" > map</ span ></ tt ></ a ></ li >
2010-01-01 22:00:21 +00:00
=======
< a name = "fusion.sequence.concepts.associative_sequence.models" ></ a >< h6 >
< a name = "id652312" ></ a >
< a class = "link" href = "associative_sequence.html#fusion.sequence.concepts.associative_sequence.models" > Models</ a >
</ h6 >
< div class = "itemizedlist" >< ul class = "itemizedlist" type = "disc" >
< li class = "listitem" >< a class = "link" href = "../../container/set.html" title = "set" >< code class = "computeroutput" >< span class = "identifier" > set</ span ></ code ></ a ></ li >
< li class = "listitem" >< a class = "link" href = "../../container/map.html" title = "map" >< code class = "computeroutput" >< span class = "identifier" > map</ span ></ code ></ a ></ li >
>>>>>>> .merge-right.r57125
2007-11-25 18:38:02 +00:00
</ ul ></ div >
</ div >
< table xmlns:rev = "http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width = "100%" >< tr >
< td align = "left" ></ td >
< td align = "right" >< div class = "copyright-footer" > Copyright © 2001-2007 Joel de Guzman, Dan Marsden, Tobias
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 > )
</ p >
</ div ></ td >
</ tr ></ table >
< hr >
< div class = "spirit-nav" >
< a accesskey = "p" href = "random_access_sequence.html" >< img src = "../../../../../../../doc/html/images/prev.png" alt = "Prev" ></ a >< a accesskey = "u" href = "../concepts.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 = "../intrinsic.html" >< img src = "../../../../../../../doc/html/images/next.png" alt = "Next" ></ a >
</ div >
</ body >
</ html >
