forked from boostorg/fusion
Regenerate fusion documentation.
[SVN r41607]
This commit is contained in:
1 parent
df69f05f94
commit
59df6ee7f1
259 files changed
+7187
-7506
No files matched your search
@@ -3,7 +3,7 @@
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||||
<title>make_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.72.0">
|
||||
<link rel="start" href="../../../../index.html" title="Chapter 1. Fusion 2.0">
|
||||
<link rel="up" href="../functions.html" title="Functions">
|
||||
<link rel="prev" href="make_set.html" title="make_set">
|
||||
@@ -14,8 +14,8 @@
|
||||
<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="http://beta.boost.org/users/people.html">People</a></td>
|
||||
<td align="center"><a href="http://beta.boost.org/users/faq.html">FAQ</a></td>
|
||||
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
|
||||
</tr></table>
|
||||
<hr>
|
||||
@@ -24,40 +24,41 @@
|
||||
</div>
|
||||
<div class="section" lang="en">
|
||||
<div class="titlepage"><div><div><h5 class="title">
|
||||
<a name="fusion.container.generation.functions.make_map"></a><a href="make_map.html" title="make_map">make_map</a></h5></div></div></div>
|
||||
<a name="fusion.container.generation.functions.make_map"></a><a href="make_map.html" title="make_map">make_map</a>
|
||||
</h5></div></div></div>
|
||||
<a name="fusion.container.generation.functions.make_map.description"></a><h6>
|
||||
<a name="id539854"></a>
|
||||
<a name="id2688942"></a>
|
||||
<a href="make_map.html#fusion.container.generation.functions.make_map.description">Description</a>
|
||||
</h6>
|
||||
<p>
|
||||
Create a <a href="../../map.html" title="map"><tt class="computeroutput"><span class="identifier">map</span></tt></a>
|
||||
Create a <a href="../../map.html" title="map"><code class="computeroutput"><span class="identifier">map</span></code></a>
|
||||
from one or more key/data pairs.
|
||||
</p>
|
||||
<a name="fusion.container.generation.functions.make_map.synopsis"></a><h6>
|
||||
<a name="id539903"></a>
|
||||
<a name="id2688984"></a>
|
||||
<a href="make_map.html#fusion.container.generation.functions.make_map.synopsis">Synopsis</a>
|
||||
</h6>
|
||||
<pre class="programlisting">
|
||||
<span class="keyword">template</span> <span class="special"><</span>
|
||||
<span class="keyword">typename</span> <span class="identifier">K0</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">K1</span><span class="special">,...</span> <span class="keyword">typename</span> <span class="identifier">KN</span>
|
||||
<span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T0</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T1</span><span class="special">,...</span> <span class="keyword">typename</span> <span class="identifier">TN</span><span class="special">></span>
|
||||
<span class="keyword">typename</span> <a href="../metafunctions/make_map.html" title="make_map"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">make_map</span></tt></a><span class="special"><</span><span class="identifier">K0</span><span class="special">,</span> <span class="identifier">K0</span><span class="special">,...</span> <span class="identifier">KN</span><span class="special">,</span> <span class="identifier">T0</span><span class="special">,</span> <span class="identifier">T1</span><span class="special">,...</span> <span class="identifier">TN</span><span class="special">>::</span><span class="identifier">type</span>
|
||||
<span class="keyword">typename</span> <a href="../metafunctions/make_map.html" title="make_map"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">make_map</span></code></a><span class="special"><</span><span class="identifier">K0</span><span class="special">,</span> <span class="identifier">K0</span><span class="special">,...</span> <span class="identifier">KN</span><span class="special">,</span> <span class="identifier">T0</span><span class="special">,</span> <span class="identifier">T1</span><span class="special">,...</span> <span class="identifier">TN</span><span class="special">>::</span><span class="identifier">type</span>
|
||||
<span class="identifier">make_map</span><span class="special">(</span><span class="identifier">T0</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">x0</span><span class="special">,</span> <span class="identifier">T1</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">x1</span><span class="special">...</span> <span class="identifier">TN</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">xN</span><span class="special">);</span>
|
||||
</pre>
|
||||
<p>
|
||||
The variadic function accepts <tt class="computeroutput"><span class="number">0</span></tt>
|
||||
to <tt class="computeroutput"><span class="identifier">FUSION_MAX_VECTOR_SIZE</span></tt>
|
||||
<sup>[<a name="id540280" href="#ftn.id540280">9</a>]</sup>
|
||||
elements, where <tt class="computeroutput"><span class="identifier">FUSION_MAX_VECTOR_SIZE</span></tt>
|
||||
is a user definable predefined maximum that defaults to <tt class="computeroutput"><span class="number">10</span></tt>. You may define the preprocessor constant
|
||||
<tt class="computeroutput"><span class="identifier">FUSION_MAX_VECTOR_SIZE</span></tt>
|
||||
The variadic function accepts <code class="computeroutput"><span class="number">0</span></code>
|
||||
to <code class="computeroutput"><span class="identifier">FUSION_MAX_VECTOR_SIZE</span></code>
|
||||
<sup>[<a name="id2689323" href="#ftn.id2689323">9</a>]</sup>
|
||||
elements, where <code class="computeroutput"><span class="identifier">FUSION_MAX_VECTOR_SIZE</span></code>
|
||||
is a user definable predefined maximum that defaults to <code class="computeroutput"><span class="number">10</span></code>. You may define the preprocessor constant
|
||||
<code class="computeroutput"><span class="identifier">FUSION_MAX_VECTOR_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_VECTOR_SIZE</span> <span class="number">20</span>
|
||||
</pre>
|
||||
<a name="fusion.container.generation.functions.make_map.parameters"></a><h6>
|
||||
<a name="id540385"></a>
|
||||
<a name="id2689421"></a>
|
||||
<a href="make_map.html#fusion.container.generation.functions.make_map.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="informaltable"><table class="table">
|
||||
@@ -87,9 +88,9 @@
|
||||
<tr>
|
||||
<td>
|
||||
<p>
|
||||
<tt class="computeroutput"><span class="identifier">K0</span><span class="special">,</span>
|
||||
<code class="computeroutput"><span class="identifier">K0</span><span class="special">,</span>
|
||||
<span class="identifier">K1</span><span class="special">,...</span>
|
||||
<span class="identifier">KN</span></tt>
|
||||
<span class="identifier">KN</span></code>
|
||||
</p>
|
||||
</td>
|
||||
<td>
|
||||
@@ -99,33 +100,33 @@
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Keys associated with <tt class="computeroutput"><span class="identifier">x0</span><span class="special">,</span> <span class="identifier">x1</span><span class="special">,...</span> <span class="identifier">xN</span></tt>
|
||||
Keys associated with <code class="computeroutput"><span class="identifier">x0</span><span class="special">,</span> <span class="identifier">x1</span><span class="special">,...</span> <span class="identifier">xN</span></code>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p>
|
||||
<tt class="computeroutput"><span class="identifier">x0</span><span class="special">,</span>
|
||||
<code class="computeroutput"><span class="identifier">x0</span><span class="special">,</span>
|
||||
<span class="identifier">x1</span><span class="special">,...</span>
|
||||
<span class="identifier">xN</span></tt>
|
||||
<span class="identifier">xN</span></code>
|
||||
</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Instances of <tt class="computeroutput"><span class="identifier">T0</span><span class="special">,</span> <span class="identifier">T1</span><span class="special">,...</span> <span class="identifier">TN</span></tt>
|
||||
Instances of <code class="computeroutput"><span class="identifier">T0</span><span class="special">,</span> <span class="identifier">T1</span><span class="special">,...</span> <span class="identifier">TN</span></code>
|
||||
</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
The arguments to <tt class="computeroutput"><span class="identifier">make_map</span></tt>
|
||||
The arguments to <code class="computeroutput"><span class="identifier">make_map</span></code>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
<a name="fusion.container.generation.functions.make_map.expression_semantics"></a><h6>
|
||||
<a name="id540653"></a>
|
||||
<a name="id2689660"></a>
|
||||
<a href="make_map.html#fusion.container.generation.functions.make_map.expression_semantics">Expression
|
||||
Semantics</a>
|
||||
</h6>
|
||||
@@ -133,20 +134,20 @@
|
||||
<span class="identifier">make_map</span><span class="special"><</span><span class="identifier">K0</span><span class="special">,</span> <span class="identifier">K1</span><span class="special">,...</span> <span class="identifier">KN</span><span class="special">>(</span><span class="identifier">x0</span><span class="special">,</span> <span class="identifier">x1</span><span class="special">,...</span> <span class="identifier">xN</span><span class="special">);</span>
|
||||
</pre>
|
||||
<p>
|
||||
<span class="bold"><b>Return type</b></span>: <a href="../metafunctions/make_map.html" title="make_map"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">make_map</span></tt></a><tt class="computeroutput"><span class="special"><</span><span class="identifier">K0</span><span class="special">,</span> <span class="identifier">K0</span><span class="special">,...</span> <span class="identifier">KN</span><span class="special">,</span> <span class="identifier">T0</span><span class="special">,</span> <span class="identifier">T1</span><span class="special">,...</span> <span class="identifier">TN</span><span class="special">>::</span><span class="identifier">type</span></tt>
|
||||
<span class="bold"><strong>Return type</strong></span>: <a href="../metafunctions/make_map.html" title="make_map"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">make_map</span></code></a><code class="computeroutput"><span class="special"><</span><span class="identifier">K0</span><span class="special">,</span> <span class="identifier">K0</span><span class="special">,...</span> <span class="identifier">KN</span><span class="special">,</span> <span class="identifier">T0</span><span class="special">,</span> <span class="identifier">T1</span><span class="special">,...</span> <span class="identifier">TN</span><span class="special">>::</span><span class="identifier">type</span></code>
|
||||
</p>
|
||||
<p>
|
||||
<span class="bold"><b>Semantics</b></span>: Create a <a href="../../map.html" title="map"><tt class="computeroutput"><span class="identifier">map</span></tt></a> from <tt class="computeroutput"><span class="identifier">K0</span><span class="special">,</span> <span class="identifier">K1</span><span class="special">,...</span> <span class="identifier">KN</span></tt>
|
||||
keys and <tt class="computeroutput"><span class="identifier">x0</span><span class="special">,</span>
|
||||
<span class="bold"><strong>Semantics</strong></span>: Create a <a href="../../map.html" title="map"><code class="computeroutput"><span class="identifier">map</span></code></a> from <code class="computeroutput"><span class="identifier">K0</span><span class="special">,</span> <span class="identifier">K1</span><span class="special">,...</span> <span class="identifier">KN</span></code>
|
||||
keys and <code class="computeroutput"><span class="identifier">x0</span><span class="special">,</span>
|
||||
<span class="identifier">x1</span><span class="special">,...</span>
|
||||
<span class="identifier">xN</span></tt> data.
|
||||
<span class="identifier">xN</span></code> data.
|
||||
</p>
|
||||
<p>
|
||||
<span class="bold"><b>Precondition</b></span>: There may be no duplicate
|
||||
<span class="bold"><strong>Precondition</strong></span>: There may be no duplicate
|
||||
key types.
|
||||
</p>
|
||||
<a name="fusion.container.generation.functions.make_map.header"></a><h6>
|
||||
<a name="id540989"></a>
|
||||
<a name="id2689960"></a>
|
||||
<a href="make_map.html#fusion.container.generation.functions.make_map.header">Header</a>
|
||||
</h6>
|
||||
<pre class="programlisting">
|
||||
@@ -154,28 +155,28 @@
|
||||
<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">make_map</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
|
||||
</pre>
|
||||
<a name="fusion.container.generation.functions.make_map.example"></a><h6>
|
||||
<a name="id541159"></a>
|
||||
<a name="id2690113"></a>
|
||||
<a href="make_map.html#fusion.container.generation.functions.make_map.example">Example</a>
|
||||
</h6>
|
||||
<pre class="programlisting">
|
||||
<span class="identifier">make_map</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>
|
||||
</pre>
|
||||
<a name="fusion.container.generation.functions.make_map.see_also"></a><h6>
|
||||
<a name="id541291"></a>
|
||||
<a name="id2690231"></a>
|
||||
<a href="make_map.html#fusion.container.generation.functions.make_map.see_also">See
|
||||
also</a>
|
||||
</h6>
|
||||
<p>
|
||||
<a href="../../../notes.html#fusion.notes.boost__ref"><tt class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">ref</span></tt></a>,
|
||||
<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>
|
||||
<a href="../../../notes.html#fusion.notes.boost__ref"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">ref</span></code></a>,
|
||||
<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>
|
||||
<div class="footnotes">
|
||||
<br><hr width="100" align="left">
|
||||
<div class="footnote"><p><sup>[<a name="ftn.id540280" href="#id540280">9</a>] </sup>
|
||||
<tt class="computeroutput"><span class="identifier">map</span></tt> is implemented
|
||||
in terms of the vector. That is why we reuse <tt class="computeroutput"><span class="identifier">FUSION_MAX_VECTOR_SIZE</span></tt>
|
||||
<div class="footnote"><p><sup>[<a name="ftn.id2689323" href="#id2689323">9</a>] </sup>
|
||||
<code class="computeroutput"><span class="identifier">map</span></code> is implemented
|
||||
in terms of the vector. That is why we reuse <code class="computeroutput"><span class="identifier">FUSION_MAX_VECTOR_SIZE</span></code>
|
||||
</p></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in new issue
Block a user