feedc0de/boost_fusion
1
0
Fork 0
forked from boostorg/fusion
Code Pull Requests Activity

adds documentation for functional module

Browse Source 
[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
Download Patch File Download Diff File Expand all files Collapse all files

126
doc/html/fusion/sequences/concepts/forward_sequence.html
View File

@ -4,7 +4,7 @@
<title>Forward
Sequence</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="../concepts.html" title="Concepts">
<link rel="prev" href="../concepts.html" title="Concepts">
@ -30,7 +30,7 @@
Sequence">Forward
Sequence</a></h4></div></div></div>
<a name="fusion.sequences.concepts.forward_sequence.description"></a><h5>
<a name="id478439"></a>
<a name="id962265"></a>
<a href="forward_sequence.html#fusion.sequences.concepts.forward_sequence.description">Description</a>
</h5>
<p>
@ -43,26 +43,26 @@
<div class="variablelist">
<p class="title"><b>Notation</b></p>
<dl>
<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>
A Forward Sequence
</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>
A Forward Sequence type
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">o</span></tt></span></dt>
<dt><span class="term"><code class="computeroutput"><span class="identifier">o</span></code></span></dt>
<dd>
An arbitrary object
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">e</span></tt></span></dt>
<dt><span class="term"><code class="computeroutput"><span class="identifier">e</span></code></span></dt>
<dd>
A Sequence element
</dd>
</dl>
</div>
<a name="fusion.sequences.concepts.forward_sequence.valid_expressions"></a><h5>
<a name="id376839"></a>
<a name="id962370"></a>
<a href="forward_sequence.html#fusion.sequences.concepts.forward_sequence.valid_expressions">Valid
Expressions</a>
</h5>
@ -85,55 +85,57 @@
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/functions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">begin</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt></td>
<td><code class="computeroutput"><a href="../intrinsics/functions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">begin</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code></td>
<td><a href="../../iterators/concepts/forward_iterator.html" title="Forward
Iterator">Forward Iterator</a></td>
<td><EFBFBD></td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/functions/end.html" title="end"><tt class="computeroutput"><span class="identifier">end</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt></td>
<td><code class="computeroutput"><a href="../intrinsics/functions/end.html" title="end"><code class="computeroutput"><span class="identifier">end</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code></td>
<td><a href="../../iterators/concepts/forward_iterator.html" title="Forward
Iterator">Forward Iterator</a></td>
<td><EFBFBD></td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/functions/size.html" title="size"><tt class="computeroutput"><span class="identifier">size</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt></td>
<td>MPL
Integral Constant. Convertible to int.</td>
<td><code class="computeroutput"><a href="../intrinsics/functions/size.html" title="size"><code class="computeroutput"><span class="identifier">size</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code></td>
<td>
<a href="http://www.boost.org/libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL
Integral Constant</a>. Convertible to int.</td>
<td><EFBFBD></td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/functions/empty.html" title="empty"><tt class="computeroutput"><span class="identifier">empty</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt></td>
<td>MPL
Boolean Constant. Convertible to bool.</td>
<td><code class="computeroutput"><a href="../intrinsics/functions/empty.html" title="empty"><code class="computeroutput"><span class="identifier">empty</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code></td>
<td>
<a href="http://www.boost.org/libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL
Boolean Constant</a>. Convertible to bool.</td>
<td><EFBFBD></td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/functions/front.html" title="front"><tt class="computeroutput"><span class="identifier">front</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt></td>
<td><code class="computeroutput"><a href="../intrinsics/functions/front.html" title="front"><code class="computeroutput"><span class="identifier">front</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code></td>
<td>Any
type</td>
<td><EFBFBD></td>
<td>Constant</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/functions/front.html" title="front"><tt class="computeroutput"><span class="identifier">front</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span> <span class="special">=</span> <span class="identifier">o</span></tt></td>
<td><code class="computeroutput"><a href="../intrinsics/functions/front.html" title="front"><code class="computeroutput"><span class="identifier">front</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span> <span class="special">=</span> <span class="identifier">o</span></code></td>
<td>Any
type</td>
<td>
<tt class="computeroutput"><span class="identifier">s</span></tt>
is mutable and <tt class="computeroutput"><span class="identifier">e</span> <span class="special">=</span> <span class="identifier">o</span></tt>,
where <tt class="computeroutput"><span class="identifier">e</span></tt> is the first
<code class="computeroutput"><span class="identifier">s</span></code>
is mutable and <code class="computeroutput"><span class="identifier">e</span> <span class="special">=</span> <span class="identifier">o</span></code>,
where <code class="computeroutput"><span class="identifier">e</span></code> is the first
element in the sequence, is a valid expression.</td>
<td>Constant</td>
</tr>
</tbody>
</table></div>
<a name="fusion.sequences.concepts.forward_sequence.result_type_expressions"></a><h5>
<a name="id479115"></a>
<a name="id962753"></a>
<a href="forward_sequence.html#fusion.sequences.concepts.forward_sequence.result_type_expressions">Result
Type Expressions</a>
</h5>
@ -148,32 +150,32 @@
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/metafunctions/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">S</span><span class="special">&gt;::</span><span class="identifier">type</span></tt></td>
<td><code class="computeroutput"><a href="../intrinsics/metafunctions/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">S</span><span class="special">&gt;::</span><span class="identifier">type</span></code></td>
<td>Amortized constant
time</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/metafunctions/end.html" title="end"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">end</span></tt></a><span class="special">&lt;</span><span class="identifier">S</span><span class="special">&gt;::</span><span class="identifier">type</span></tt></td>
<td><code class="computeroutput"><a href="../intrinsics/metafunctions/end.html" title="end"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">end</span></code></a><span class="special">&lt;</span><span class="identifier">S</span><span class="special">&gt;::</span><span class="identifier">type</span></code></td>
<td>Amortized constant
time</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/metafunctions/size.html" title="size"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">size</span></tt></a><span class="special">&lt;</span><span class="identifier">S</span><span class="special">&gt;::</span><span class="identifier">type</span></tt></td>
<td><code class="computeroutput"><a href="../intrinsics/metafunctions/size.html" title="size"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">size</span></code></a><span class="special">&lt;</span><span class="identifier">S</span><span class="special">&gt;::</span><span class="identifier">type</span></code></td>
<td>Unspecified</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/metafunctions/empty.html" title="empty"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">empty</span></tt></a><span class="special">&lt;</span><span class="identifier">S</span><span class="special">&gt;::</span><span class="identifier">type</span></tt></td>
<td><code class="computeroutput"><a href="../intrinsics/metafunctions/empty.html" title="empty"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">empty</span></code></a><span class="special">&lt;</span><span class="identifier">S</span><span class="special">&gt;::</span><span class="identifier">type</span></code></td>
<td>Constant time</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/metafunctions/front.html" title="front"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">front</span></tt></a><span class="special">&lt;</span><span class="identifier">S</span><span class="special">&gt;::</span><span class="identifier">type</span></tt></td>
<td><code class="computeroutput"><a href="../intrinsics/metafunctions/front.html" title="front"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">front</span></code></a><span class="special">&lt;</span><span class="identifier">S</span><span class="special">&gt;::</span><span class="identifier">type</span></code></td>
<td>Amortized constant
time</td>
</tr>
</tbody>
</table></div>
<a name="fusion.sequences.concepts.forward_sequence.expression_semantics"></a><h5>
<a name="id479469"></a>
<a name="id963063"></a>
<a href="forward_sequence.html#fusion.sequences.concepts.forward_sequence.expression_semantics">Expression
Semantics</a>
</h5>
@ -188,37 +190,37 @@
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/functions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">begin</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt></td>
<td><code class="computeroutput"><a href="../intrinsics/functions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">begin</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code></td>
<td>An
iterator to the first element of the sequence; see <a href="../intrinsics/functions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">begin</span></tt></a>.</td>
iterator to the first element of the sequence; see <a href="../intrinsics/functions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">begin</span></code></a>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/functions/end.html" title="end"><tt class="computeroutput"><span class="identifier">end</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt></td>
<td><code class="computeroutput"><a href="../intrinsics/functions/end.html" title="end"><code class="computeroutput"><span class="identifier">end</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code></td>
<td>A
past-the-end iterator to the sequence; see <a href="../intrinsics/functions/end.html" title="end"><tt class="computeroutput"><span class="identifier">end</span></tt></a>.</td>
past-the-end iterator to the sequence; see <a href="../intrinsics/functions/end.html" title="end"><code class="computeroutput"><span class="identifier">end</span></code></a>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/functions/size.html" title="size"><tt class="computeroutput"><span class="identifier">size</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt></td>
<td><code class="computeroutput"><a href="../intrinsics/functions/size.html" title="size"><code class="computeroutput"><span class="identifier">size</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code></td>
<td>The
size of the sequence; see <a href="../intrinsics/functions/size.html" title="size"><tt class="computeroutput"><span class="identifier">size</span></tt></a>.</td>
size of the sequence; see <a href="../intrinsics/functions/size.html" title="size"><code class="computeroutput"><span class="identifier">size</span></code></a>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/functions/empty.html" title="empty"><tt class="computeroutput"><span class="identifier">empty</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt></td>
<td><code class="computeroutput"><a href="../intrinsics/functions/empty.html" title="empty"><code class="computeroutput"><span class="identifier">empty</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code></td>
<td>A
boolean Integral Constant <tt class="computeroutput"><span class="identifier">c</span></tt>
such that <tt class="computeroutput"><span class="identifier">c</span><span class="special">::</span><span class="identifier">value</span> <span class="special">==</span>
<span class="keyword">true</span></tt> if and only if the sequence
is empty; see <a href="../intrinsics/functions/empty.html" title="empty"><tt class="computeroutput"><span class="identifier">empty</span></tt></a>.</td>
boolean Integral Constant <code class="computeroutput"><span class="identifier">c</span></code>
such that <code class="computeroutput"><span class="identifier">c</span><span class="special">::</span><span class="identifier">value</span> <span class="special">==</span>
<span class="keyword">true</span></code> if and only if the sequence
is empty; see <a href="../intrinsics/functions/empty.html" title="empty"><code class="computeroutput"><span class="identifier">empty</span></code></a>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/functions/front.html" title="front"><tt class="computeroutput"><span class="identifier">front</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt></td>
<td><code class="computeroutput"><a href="../intrinsics/functions/front.html" title="front"><code class="computeroutput"><span class="identifier">front</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code></td>
<td>The
first element in the sequence; see <a href="../intrinsics/functions/front.html" title="front"><tt class="computeroutput"><span class="identifier">front</span></tt></a>.</td>
first element in the sequence; see <a href="../intrinsics/functions/front.html" title="front"><code class="computeroutput"><span class="identifier">front</span></code></a>.</td>
</tr>
</tbody>
</table></div>
<a name="fusion.sequences.concepts.forward_sequence.invariants"></a><h5>
<a name="id479860"></a>
<a name="id963409"></a>
<a href="forward_sequence.html#fusion.sequences.concepts.forward_sequence.invariants">Invariants</a>
</h5>
<p>
@ -226,41 +228,41 @@
</p>
<div class="itemizedlist"><ul type="disc">
<li>
<tt class="computeroutput"><span class="special">[</span><a href="../intrinsics/functions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">begin</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">),</span> <a href="../intrinsics/functions/end.html" title="end"><tt class="computeroutput"><span class="identifier">end</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">))</span></tt> is always a valid range.
<code class="computeroutput"><span class="special">[</span><a href="../intrinsics/functions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">begin</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">),</span> <a href="../intrinsics/functions/end.html" title="end"><code class="computeroutput"><span class="identifier">end</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">))</span></code> is always a valid range.
</li>
<li>
An <a href="../../algorithms.html" title="Algorithms">Algorithm</a> that iterates through
the range <tt class="computeroutput"><span class="special">[</span><a href="../intrinsics/functions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">begin</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">),</span> <a href="../intrinsics/functions/end.html" title="end"><tt class="computeroutput"><span class="identifier">end</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">))</span></tt> will pass through every element of
<tt class="computeroutput"><span class="identifier">s</span></tt> exactly once.
the range <code class="computeroutput"><span class="special">[</span><a href="../intrinsics/functions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">begin</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">),</span> <a href="../intrinsics/functions/end.html" title="end"><code class="computeroutput"><span class="identifier">end</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">))</span></code> will pass through every element of
<code class="computeroutput"><span class="identifier">s</span></code> exactly once.
</li>
<li>
<tt class="computeroutput"><a href="../intrinsics/functions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">begin</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt>
is identical to <tt class="computeroutput"><a href="../intrinsics/functions/end.html" title="end"><tt class="computeroutput"><span class="identifier">end</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">))</span></tt>
if and only if <tt class="computeroutput"><span class="identifier">s</span></tt> is empty.
<code class="computeroutput"><a href="../intrinsics/functions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">begin</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code>
is identical to <code class="computeroutput"><a href="../intrinsics/functions/end.html" title="end"><code class="computeroutput"><span class="identifier">end</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">))</span></code>
if and only if <code class="computeroutput"><span class="identifier">s</span></code> is empty.
</li>
<li>
Two different iterations through <tt class="computeroutput"><span class="identifier">s</span></tt>
Two different iterations through <code class="computeroutput"><span class="identifier">s</span></code>
will access its elements in the same order.
</li>
</ul></div>
<a name="fusion.sequences.concepts.forward_sequence.models"></a><h5>
<a name="id480163"></a>
<a name="id963677"></a>
<a href="forward_sequence.html#fusion.sequences.concepts.forward_sequence.models">Models</a>
</h5>
<div class="itemizedlist"><ul type="disc">
<li><a href="../adapted/std__pair.html" title="std::pair"><tt class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span></tt></a></li>
<li><a href="../adapted/boost__array.html" title="boost::array"><tt class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">array</span></tt></a></li>
<li><a href="../containers/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a></li>
<li><a href="../containers/cons.html" title="cons"><tt class="computeroutput"><span class="identifier">cons</span></tt></a></li>
<li><a href="../containers/list.html" title="list"><tt class="computeroutput"><span class="identifier">list</span></tt></a></li>
<li><a href="../containers/set.html" title="set"><tt class="computeroutput"><span class="identifier">set</span></tt></a></li>
<li><a href="../containers/map.html" title="map"><tt class="computeroutput"><span class="identifier">map</span></tt></a></li>
<li><a href="../views/single_view.html" title="single_view"><tt class="computeroutput"><span class="identifier">single_view</span></tt></a></li>
<li><a href="../views/filter_view.html" title="filter_view"><tt class="computeroutput"><span class="identifier">filter_view</span></tt></a></li>
<li><a href="../views/iterator_range.html" title="iterator_range"><tt class="computeroutput"><span class="identifier">iterator_range</span></tt></a></li>
<li><a href="../views/joint_view.html" title="joint_view"><tt class="computeroutput"><span class="identifier">joint_view</span></tt></a></li>
<li><a href="../views/transform_view.html" title="transform_view"><tt class="computeroutput"><span class="identifier">transform_view</span></tt></a></li>
<li><a href="../views/reverse_view.html" title="reverse_view"><tt class="computeroutput"><span class="identifier">reverse_view</span></tt></a></li>
<li><a href="../adapted/std__pair.html" title="std::pair"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span></code></a></li>
<li><a href="../adapted/boost__array.html" title="boost::array"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">array</span></code></a></li>
<li><a href="../containers/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></a></li>
<li><a href="../containers/cons.html" title="cons"><code class="computeroutput"><span class="identifier">cons</span></code></a></li>
<li><a href="../containers/list.html" title="list"><code class="computeroutput"><span class="identifier">list</span></code></a></li>
<li><a href="../containers/set.html" title="set"><code class="computeroutput"><span class="identifier">set</span></code></a></li>
<li><a href="../containers/map.html" title="map"><code class="computeroutput"><span class="identifier">map</span></code></a></li>
<li><a href="../views/single_view.html" title="single_view"><code class="computeroutput"><span class="identifier">single_view</span></code></a></li>
<li><a href="../views/filter_view.html" title="filter_view"><code class="computeroutput"><span class="identifier">filter_view</span></code></a></li>
<li><a href="../views/iterator_range.html" title="iterator_range"><code class="computeroutput"><span class="identifier">iterator_range</span></code></a></li>
<li><a href="../views/joint_view.html" title="joint_view"><code class="computeroutput"><span class="identifier">joint_view</span></code></a></li>
<li><a href="../views/transform_view.html" title="transform_view"><code class="computeroutput"><span class="identifier">transform_view</span></code></a></li>
<li><a href="../views/reverse_view.html" title="reverse_view"><code class="computeroutput"><span class="identifier">reverse_view</span></code></a></li>
</ul></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>