adds documentation for functional module

[SVN r36959]
This commit is contained in:
Tobias Schwinger
2007-02-15 23:11:24 +00:00
parent 67f0df4958
commit ca6f831b96
247 changed files with 8675 additions and 3833 deletions

View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>as_set</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_vector.html" title="as_vector">
@ -26,14 +26,14 @@
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.sequences.conversion.functions.as_set"></a><a href="as_set.html" title="as_set">as_set</a></h5></div></div></div>
<a name="fusion.sequences.conversion.functions.as_set.description"></a><h6>
<a name="id540495"></a>
<a name="id1069430"></a>
<a href="as_set.html#fusion.sequences.conversion.functions.as_set.description">Description</a>
</h6>
<p>
Convert a fusion sequence to a <a href="../../containers/set.html" title="set"><tt class="computeroutput"><span class="identifier">set</span></tt></a>.
Convert a fusion sequence to a <a href="../../containers/set.html" title="set"><code class="computeroutput"><span class="identifier">set</span></code></a>.
</p>
<a name="fusion.sequences.conversion.functions.as_set.synopsis"></a><h6>
<a name="id540542"></a>
<a name="id1069472"></a>
<a href="as_set.html#fusion.sequences.conversion.functions.as_set.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
@ -46,7 +46,7 @@
<span class="identifier">as_set</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_set.parameters"></a><h6>
<a name="id540799"></a>
<a name="id1069697"></a>
<a href="as_set.html#fusion.sequences.conversion.functions.as_set.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_set.expression_semantics"></a><h6>
<a name="id540878"></a>
<a name="id1069770"></a>
<a href="as_set.html#fusion.sequences.conversion.functions.as_set.expression_semantics">Expression
Semantics</a>
</h6>
@ -76,29 +76,29 @@
<span class="identifier">as_set</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_set.html" title="as_set"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">as_set</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_set.html" title="as_set"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">as_set</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/set.html" title="set"><tt class="computeroutput"><span class="identifier">set</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/set.html" title="set"><code class="computeroutput"><span class="identifier">set</span></code></a>.
</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.sequences.conversion.functions.as_set.header"></a><h6>
<a name="id541043"></a>
<a name="id1069915"></a>
<a href="as_set.html#fusion.sequences.conversion.functions.as_set.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_set</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.conversion.functions.as_set.example"></a><h6>
<a name="id541148"></a>
<a name="id1070007"></a>
<a href="as_set.html#fusion.sequences.conversion.functions.as_set.example">Example</a>
</h6>
<pre class="programlisting">
<span class="identifier">as_set</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><span class="char">'x'</span><span class="special">,</span> <span class="number">123</span><span class="special">,</span> <span class="string">"hello"</span><span class="special">))</span>
<span class="identifier">as_set</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><span class="char">'x'</span><span class="special">,</span> <span class="number">123</span><span class="special">,</span> <span class="string">"hello"</span><span class="special">))</span>
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>