introduces documentation for deduce / deduce_sequence

[SVN r36813]
This commit is contained in:
Tobias Schwinger
2007-01-27 10:52:43 +00:00
parent 1c542fa544
commit 586440e16e
215 changed files with 4061 additions and 3767 deletions

View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>as_map</title>
<link rel="stylesheet" href="../../../../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="../functions.html" title="Functions">
<link rel="prev" href="as_set.html" title="as_set">
@ -26,14 +26,14 @@
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.sequences.conversion.functions.as_map"></a><a href="as_map.html" title="as_map">as_map</a></h5></div></div></div>
<a name="fusion.sequences.conversion.functions.as_map.description"></a><h6>
<a name="id539472"></a>
<a name="id1070016"></a>
<a href="as_map.html#fusion.sequences.conversion.functions.as_map.description">Description</a>
</h6>
<p>
Convert a fusion sequence to a <a href="../../containers/map.html" title="map"><tt class="computeroutput"><span class="identifier">map</span></tt></a>.
Convert a fusion sequence to a <a href="../../containers/map.html" title="map"><code class="computeroutput"><span class="identifier">map</span></code></a>.
</p>
<a name="fusion.sequences.conversion.functions.as_map.synopsis"></a><h6>
<a name="id539519"></a>
<a name="id1070058"></a>
<a href="as_map.html#fusion.sequences.conversion.functions.as_map.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
@ -46,7 +46,7 @@
<span class="identifier">as_map</span><span class="special">(</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
</pre>
<a name="fusion.sequences.conversion.functions.as_map.parameters"></a><h6>
<a name="id539775"></a>
<a name="id1070284"></a>
<a href="as_map.html#fusion.sequences.conversion.functions.as_map.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
@ -61,14 +61,14 @@
<th>Description</th>
</tr></thead>
<tbody><tr>
<td><tt class="computeroutput"><span class="identifier">seq</span></tt></td>
<td><code class="computeroutput"><span class="identifier">seq</span></code></td>
<td>An
instance of Sequence</td>
<td>The sequence to convert.</td>
</tr></tbody>
</table></div>
<a name="fusion.sequences.conversion.functions.as_map.expression_semantics"></a><h6>
<a name="id539854"></a>
<a name="id1070356"></a>
<a href="as_map.html#fusion.sequences.conversion.functions.as_map.expression_semantics">Expression
Semantics</a>
</h6>
@ -76,32 +76,32 @@
<span class="identifier">as_map</span><span class="special">(</span><span class="identifier">seq</span><span class="special">);</span>
</pre>
<p>
<span class="bold"><b>Return type</b></span>: <a href="../metafunctions/as_map.html" title="as_map"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">as_map</span></tt></a><tt class="computeroutput"><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span></tt>
<span class="bold"><strong>Return type</strong></span>: <a href="../metafunctions/as_map.html" title="as_map"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">as_map</span></code></a><code class="computeroutput"><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span></code>
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Convert a fusion sequence,
<tt class="computeroutput"><span class="identifier">seq</span></tt>, to a <a href="../../containers/map.html" title="map"><tt class="computeroutput"><span class="identifier">map</span></tt></a>.
<span class="bold"><strong>Semantics</strong></span>: Convert a fusion sequence,
<code class="computeroutput"><span class="identifier">seq</span></code>, to a <a href="../../containers/map.html" title="map"><code class="computeroutput"><span class="identifier">map</span></code></a>.
</p>
<p>
<span class="bold"><b>Precondition</b></span>: The elements of the sequence
<span class="bold"><strong>Precondition</strong></span>: The elements of the sequence
are assumed to be __fusion<span class="underline">pair</span>_s.
There may be no duplicate <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> key types.
There may be no duplicate <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> key types.
</p>
<a name="fusion.sequences.conversion.functions.as_map.header"></a><h6>
<a name="id540052"></a>
<a name="id1070530"></a>
<a href="as_map.html#fusion.sequences.conversion.functions.as_map.header">Header</a>
</h6>
<pre class="programlisting">
<span class="preprocessor">#include</span> <span class="special">&lt;</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">conversion</span><span class="special">/</span><span class="identifier">as_map</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.conversion.functions.as_map.example"></a><h6>
<a name="id540157"></a>
<a name="id1070623"></a>
<a href="as_map.html#fusion.sequences.conversion.functions.as_map.example">Example</a>
</h6>
<pre class="programlisting">
<span class="identifier">as_map</span><span class="special">(</span><a href="../../generation/functions/make_vector.html" title="make_vector"><tt class="computeroutput"><span class="identifier">make_vector</span></tt></a><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">&lt;</span><span class="keyword">int</span><span class="special">&gt;(</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">&lt;</span><span class="keyword">double</span><span class="special">&gt;(</span><span class="string">"Men"</span><span class="special">)))</span>
<span class="identifier">as_map</span><span class="special">(</span><a href="../../generation/functions/make_vector.html" title="make_vector"><code class="computeroutput"><span class="identifier">make_vector</span></code></a><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">&lt;</span><span class="keyword">int</span><span class="special">&gt;(</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">&lt;</span><span class="keyword">double</span><span class="special">&gt;(</span><span class="string">"Men"</span><span class="special">)))</span>
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>