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>begin</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="../metafunctions.html" title="Metafunctions">
<link rel="prev" href="../metafunctions.html" title="Metafunctions">
@ -26,14 +26,14 @@
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.sequences.intrinsics.metafunctions.begin"></a><a href="begin.html" title="begin">begin</a></h5></div></div></div>
<a name="fusion.sequences.intrinsics.metafunctions.begin.description"></a><h6>
<a name="id514655"></a>
<a name="id1011622"></a>
<a href="begin.html#fusion.sequences.intrinsics.metafunctions.begin.description">Description</a>
</h6>
<p>
Returns the result type of <a href="../functions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">begin</span></tt></a>.
Returns the result type of <a href="../functions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">begin</span></code></a>.
</p>
<a name="fusion.sequences.intrinsics.metafunctions.begin.synopsis"></a><h6>
<a name="id514703"></a>
<a name="id1011664"></a>
<a href="begin.html#fusion.sequences.intrinsics.metafunctions.begin.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
@ -44,7 +44,7 @@
<span class="special">};</span>
</pre>
<div class="table">
<a name="id514801"></a><p class="title"><b>Table<EFBFBD>1.19.<2E>Parameters</b></p>
<a name="id1011750"></a><p class="title"><b>Table<EFBFBD>1.19.<2E>Parameters</b></p>
<table class="table" summary="Parameters">
<colgroup>
<col>
@ -57,7 +57,7 @@
<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>A
model of <a href="../../concepts/forward_sequence.html" title="Forward
Sequence">Forward
@ -68,7 +68,7 @@
</table>
</div>
<a name="fusion.sequences.intrinsics.metafunctions.begin.expression_semantics"></a><h6>
<a name="id514876"></a>
<a name="id1011818"></a>
<a href="begin.html#fusion.sequences.intrinsics.metafunctions.begin.expression_semantics">Expression
Semantics</a>
</h6>
@ -76,28 +76,28 @@
<span class="identifier">result_of</span><span class="special">::</span><span class="identifier">begin</span><span class="special">&lt;</span><span class="identifier">Seq</span><span class="special">&gt;::</span><span class="identifier">type</span>
</pre>
<p>
<span class="bold"><b>Return type</b></span>: An iterator modelling the
same traversal concept as <tt class="computeroutput"><span class="identifier">Seq</span></tt>.
<span class="bold"><strong>Return type</strong></span>: An iterator modelling the
same traversal concept as <code class="computeroutput"><span class="identifier">Seq</span></code>.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Returns the type of an iterator
to the first element of <tt class="computeroutput"><span class="identifier">Seq</span></tt>.
<span class="bold"><strong>Semantics</strong></span>: Returns the type of an iterator
to the first element of <code class="computeroutput"><span class="identifier">Seq</span></code>.
</p>
<a name="fusion.sequences.intrinsics.metafunctions.begin.header"></a><h6>
<a name="id514988"></a>
<a name="id1011917"></a>
<a href="begin.html#fusion.sequences.intrinsics.metafunctions.begin.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">intrinsic</span><span class="special">/</span><span class="identifier">begin</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.intrinsics.metafunctions.begin.example"></a><h6>
<a name="id515094"></a>
<a name="id1012010"></a>
<a href="begin.html#fusion.sequences.intrinsics.metafunctions.begin.example">Example</a>
</h6>
<pre class="programlisting">
<span class="keyword">typedef</span> <a href="../../containers/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">vec</span><span class="special">;</span>
<span class="keyword">typedef</span> <a href="begin.html" title="begin"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">begin</span></tt></a><span class="special">&lt;</span><span class="identifier">vec</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">it</span><span class="special">;</span>
<span class="identifier">BOOST_MPL_ASSERT</span><span class="special">((</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_same</span><span class="special">&lt;</span><a href="../../../iterators/metafunctions/deref.html" title="deref"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">deref</span></tt></a><span class="special">&lt;</span><span class="identifier">it</span><span class="special">&gt;::</span><span class="identifier">type</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&amp;&gt;))</span>
<span class="keyword">typedef</span> <a href="../../containers/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">vec</span><span class="special">;</span>
<span class="keyword">typedef</span> <a href="begin.html" title="begin"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">begin</span></code></a><span class="special">&lt;</span><span class="identifier">vec</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">it</span><span class="special">;</span>
<span class="identifier">BOOST_MPL_ASSERT</span><span class="special">((</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_same</span><span class="special">&lt;</span><a href="../../../iterators/metafunctions/deref.html" title="deref"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">deref</span></code></a><span class="special">&lt;</span><span class="identifier">it</span><span class="special">&gt;::</span><span class="identifier">type</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&amp;&gt;))</span>
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>