forked from boostorg/fusion
updates functional module: only two unfused variants, now
[SVN r51381]
This commit is contained in:
@ -3,7 +3,7 @@
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||||
<title>map</title>
|
||||
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
|
||||
<link rel="start" href="../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
|
||||
<link rel="up" href="../container.html" title="Container">
|
||||
<link rel="prev" href="set.html" title="set">
|
||||
@ -26,35 +26,33 @@
|
||||
<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>
|
||||
<a name="id535915"></a>
|
||||
<a name="id1075408"></a>
|
||||
<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>)
|
||||
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>)
|
||||
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>
|
||||
<a name="id535996"></a>
|
||||
<a name="id1075479"></a>
|
||||
<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>
|
||||
<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>
|
||||
<a name="id536278"></a>
|
||||
<a name="id1075726"></a>
|
||||
<a href="map.html#fusion.container.map.synopsis">Synopsis</a>
|
||||
</h4>
|
||||
<pre class="programlisting">
|
||||
<span class="keyword">template</span> <span class="special"><</span>
|
||||
<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>
|
||||
@ -64,24 +62,22 @@
|
||||
<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>.
|
||||
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>.
|
||||
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 class="programlisting"><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>
|
||||
</pre>
|
||||
<p>
|
||||
You may define the preprocessor constant <tt class="computeroutput"><span class="identifier">FUSION_MAX_MAP_SIZE</span></tt>
|
||||
You may define the preprocessor constant <code class="computeroutput"><span class="identifier">FUSION_MAX_MAP_SIZE</span></code>
|
||||
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 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>
|
||||
<a name="id536707"></a>
|
||||
<a name="id1076102"></a>
|
||||
<a href="map.html#fusion.container.map.template_parameters">Template parameters</a>
|
||||
</h4>
|
||||
<div class="informaltable"><table class="table">
|
||||
@ -110,7 +106,7 @@
|
||||
<tbody><tr>
|
||||
<td>
|
||||
<p>
|
||||
<tt class="computeroutput"><span class="identifier">T0</span></tt>...<tt class="computeroutput"><span class="identifier">TN</span></tt>
|
||||
<code class="computeroutput"><span class="identifier">T0</span></code>...<code class="computeroutput"><span class="identifier">TN</span></code>
|
||||
</p>
|
||||
</td>
|
||||
<td>
|
||||
@ -126,7 +122,7 @@
|
||||
</tr></tbody>
|
||||
</table></div>
|
||||
<a name="fusion.container.map.model_of"></a><h4>
|
||||
<a name="id536827"></a>
|
||||
<a name="id1076208"></a>
|
||||
<a href="map.html#fusion.container.map.model_of">Model of</a>
|
||||
</h4>
|
||||
<div class="itemizedlist"><ul type="disc">
|
||||
@ -139,19 +135,19 @@
|
||||
<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>
|
||||
<dt><span class="term"><code class="computeroutput"><span class="identifier">M</span></code></span></dt>
|
||||
<dd><p>
|
||||
A <tt class="computeroutput"><span class="identifier">map</span></tt> type
|
||||
A <code class="computeroutput"><span class="identifier">map</span></code> type
|
||||
</p></dd>
|
||||
<dt><span class="term"><tt class="computeroutput"><span class="identifier">m</span></tt></span></dt>
|
||||
<dt><span class="term"><code class="computeroutput"><span class="identifier">m</span></code></span></dt>
|
||||
<dd><p>
|
||||
An instance of <tt class="computeroutput"><span class="identifier">map</span></tt>
|
||||
An instance of <code class="computeroutput"><span class="identifier">map</span></code>
|
||||
</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>
|
||||
<dt><span class="term"><code class="computeroutput"><span class="identifier">e0</span></code>...<code class="computeroutput"><span class="identifier">en</span></code></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>)
|
||||
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>)
|
||||
</p></dd>
|
||||
<dt><span class="term"><tt class="computeroutput"><span class="identifier">s</span></tt></span></dt>
|
||||
<dt><span class="term"><code class="computeroutput"><span class="identifier">s</span></code></span></dt>
|
||||
<dd><p>
|
||||
A <a href="../sequence/concepts/forward_sequence.html" title="Forward
|
||||
Sequence">Forward Sequence</a>
|
||||
@ -159,7 +155,7 @@
|
||||
</dl>
|
||||
</div>
|
||||
<a name="fusion.container.map.expression_semantics"></a><h4>
|
||||
<a name="id537050"></a>
|
||||
<a name="id1076404"></a>
|
||||
<a href="map.html#fusion.container.map.expression_semantics">Expression Semantics</a>
|
||||
</h4>
|
||||
<p>
|
||||
@ -191,7 +187,7 @@
|
||||
<tr>
|
||||
<td>
|
||||
<p>
|
||||
<tt class="computeroutput"><span class="identifier">M</span><span class="special">()</span></tt>
|
||||
<code class="computeroutput"><span class="identifier">M</span><span class="special">()</span></code>
|
||||
</p>
|
||||
</td>
|
||||
<td>
|
||||
@ -203,64 +199,63 @@
|
||||
<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>
|
||||
<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 <tt class="computeroutput"><span class="identifier">e0</span></tt>...<tt class="computeroutput"><span class="identifier">en</span></tt>.
|
||||
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>
|
||||
</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>
|
||||
<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="../sequence/concepts/forward_sequence.html" title="Forward
|
||||
Sequence">Forward
|
||||
Sequence</a> <tt class="computeroutput"><span class="identifier">s</span></tt>.
|
||||
Sequence</a> <code class="computeroutput"><span class="identifier">s</span></code>.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p>
|
||||
<tt class="computeroutput"><span class="identifier">m</span> <span class="special">=</span>
|
||||
<span class="identifier">s</span></tt>
|
||||
<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, <tt class="computeroutput"><span class="identifier">m</span></tt>,
|
||||
Assigns to a map, <code class="computeroutput"><span class="identifier">m</span></code>,
|
||||
from a <a href="../sequence/concepts/forward_sequence.html" title="Forward
|
||||
Sequence">Forward
|
||||
Sequence</a> <tt class="computeroutput"><span class="identifier">s</span></tt>.
|
||||
Sequence</a> <code class="computeroutput"><span class="identifier">s</span></code>.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
<a name="fusion.container.map.example"></a><h4>
|
||||
<a name="id537398"></a>
|
||||
<a name="id1076712"></a>
|
||||
<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>
|
||||
<pre class="programlisting"><span class="keyword">typedef</span> <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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
|
||||
<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>
|
||||
<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"><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="../sequence/intrinsic/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>
|
||||
</pre>
|
||||
</div>
|
||||
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
|
||||
|
Reference in New Issue
Block a user