revises function object concepts and functional module documenation to reflect

boost::result_of-based result computation


[SVN r38209]
This commit is contained in:
Tobias Schwinger
2007-07-13 19:25:34 +00:00
parent f05493abf0
commit 9df373af5f
227 changed files with 10684 additions and 4457 deletions

View File

@ -26,14 +26,14 @@
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.iterators.functions.advance"></a><a href="advance.html" title="advance">advance</a></h4></div></div></div>
<a name="fusion.iterators.functions.advance.description"></a><h5>
<a name="id934746"></a>
<a name="id941870"></a>
<a href="advance.html#fusion.iterators.functions.advance.description">Description</a>
</h5>
<p>
Moves an iterator by a specified distance.
</p>
<a name="fusion.iterators.functions.advance.synopsis"></a><h5>
<a name="id934772"></a>
<a name="id941896"></a>
<a href="advance.html#fusion.iterators.functions.advance.synopsis">Synopsis</a>
</h5>
<pre class="programlisting">
@ -44,7 +44,7 @@
<span class="keyword">typename</span> <a href="../metafunctions/advance.html" title="advance"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">advance</span></code></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">,</span> <span class="identifier">M</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">advance</span><span class="special">(</span><span class="identifier">I</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">i</span><span class="special">);</span>
</pre>
<div class="table">
<a name="id934922"></a><p class="title"><b>Table<EFBFBD>1.6.<2E>Parameters</b></p>
<a name="id942048"></a><p class="title"><b>Table<EFBFBD>1.6.<2E>Parameters</b></p>
<table class="table" summary="Parameters">
<colgroup>
<col>
@ -52,33 +52,65 @@
<col>
</colgroup>
<thead><tr>
<th>Parameter</th>
<th>Requirement</th>
<th>Description</th>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Requirement
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td><code class="computeroutput"><span class="identifier">i</span></code></td>
<td>Model
of <a href="../concepts/forward_iterator.html" title="Forward
<td>
<p>
<code class="computeroutput"><span class="identifier">i</span></code>
</p>
</td>
<td>
<p>
Model of <a href="../concepts/forward_iterator.html" title="Forward
Iterator">Forward
Iterator</a>
</td>
<td>Iterator to move relative to</td>
Iterator</a>
</p>
</td>
<td>
<p>
Iterator to move relative to
</p>
</td>
</tr>
<tr>
<td><code class="computeroutput"><span class="identifier">N</span></code></td>
<td>An
<a href="http://www.boost.org/libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL
Integral Constant</a>
</td>
<td>Number of positions to move</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">N</span></code>
</p>
</td>
<td>
<p>
An <a href="http://www.boost.org/libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL
Integral Constant</a>
</p>
</td>
<td>
<p>
Number of positions to move
</p>
</td>
</tr>
</tbody>
</table>
</div>
<a name="fusion.iterators.functions.advance.expression_semantics"></a><h5>
<a name="id935011"></a>
<a name="id942177"></a>
<a href="advance.html#fusion.iterators.functions.advance.expression_semantics">Expression
Semantics</a>
</h5>
@ -99,14 +131,14 @@
may be negative.
</p>
<a name="fusion.iterators.functions.advance.header"></a><h5>
<a name="id935149"></a>
<a name="id942324"></a>
<a href="advance.html#fusion.iterators.functions.advance.header">Header</a>
</h5>
<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">iterator</span><span class="special">/</span><span class="identifier">advance</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.iterators.functions.advance.example"></a><h5>
<a name="id935232"></a>
<a name="id942408"></a>
<a href="advance.html#fusion.iterators.functions.advance.example">Example</a>
</h5>
<pre class="programlisting">

View File

@ -26,14 +26,14 @@
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.iterators.functions.advance_c"></a><a href="advance_c.html" title="advance_c">advance_c</a></h4></div></div></div>
<a name="fusion.iterators.functions.advance_c.description"></a><h5>
<a name="id935495"></a>
<a name="id942672"></a>
<a href="advance_c.html#fusion.iterators.functions.advance_c.description">Description</a>
</h5>
<p>
Moves an iterator by a specified distance.
</p>
<a name="fusion.iterators.functions.advance_c.synopsis"></a><h5>
<a name="id935523"></a>
<a name="id942700"></a>
<a href="advance_c.html#fusion.iterators.functions.advance_c.synopsis">Synopsis</a>
</h5>
<pre class="programlisting">
@ -44,7 +44,7 @@
<span class="keyword">typename</span> <a href="../metafunctions/advance_c.html" title="advance_c"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">advance_c</span></code></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">,</span> <span class="identifier">N</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">advance_c</span><span class="special">(</span><span class="identifier">I</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">i</span><span class="special">);</span>
</pre>
<div class="table">
<a name="id935674"></a><p class="title"><b>Table<EFBFBD>1.7.<2E>Parameters</b></p>
<a name="id942852"></a><p class="title"><b>Table<EFBFBD>1.7.<2E>Parameters</b></p>
<table class="table" summary="Parameters">
<colgroup>
<col>
@ -52,31 +52,64 @@
<col>
</colgroup>
<thead><tr>
<th>Parameter</th>
<th>Requirement</th>
<th>Description</th>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Requirement
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td><code class="computeroutput"><span class="identifier">i</span></code></td>
<td>Model
of <a href="../concepts/forward_iterator.html" title="Forward
<td>
<p>
<code class="computeroutput"><span class="identifier">i</span></code>
</p>
</td>
<td>
<p>
Model of <a href="../concepts/forward_iterator.html" title="Forward
Iterator">Forward
Iterator</a>
</td>
<td>Iterator to move relative to</td>
Iterator</a>
</p>
</td>
<td>
<p>
Iterator to move relative to
</p>
</td>
</tr>
<tr>
<td><code class="computeroutput"><span class="identifier">N</span></code></td>
<td>Integer
constant</td>
<td>Number of positions to move</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">N</span></code>
</p>
</td>
<td>
<p>
Integer constant
</p>
</td>
<td>
<p>
Number of positions to move
</p>
</td>
</tr>
</tbody>
</table>
</div>
<a name="fusion.iterators.functions.advance_c.expression_semantics"></a><h5>
<a name="id935756"></a>
<a name="id942975"></a>
<a href="advance_c.html#fusion.iterators.functions.advance_c.expression_semantics">Expression
Semantics</a>
</h5>
@ -97,14 +130,14 @@
may be negative.
</p>
<a name="fusion.iterators.functions.advance_c.header"></a><h5>
<a name="id935895"></a>
<a name="id943121"></a>
<a href="advance_c.html#fusion.iterators.functions.advance_c.header">Header</a>
</h5>
<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">iterator</span><span class="special">/</span><span class="identifier">advance</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.iterators.functions.advance_c.example"></a><h5>
<a name="id935977"></a>
<a name="id943205"></a>
<a href="advance_c.html#fusion.iterators.functions.advance_c.example">Example</a>
</h5>
<pre class="programlisting">

View File

@ -26,14 +26,14 @@
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.iterators.functions.deref"></a><a href="deref.html" title="deref">deref</a></h4></div></div></div>
<a name="fusion.iterators.functions.deref.description"></a><h5>
<a name="id931691"></a>
<a name="id938677"></a>
<a href="deref.html#fusion.iterators.functions.deref.description">Description</a>
</h5>
<p>
Deferences an iterator.
</p>
<a name="fusion.iterators.functions.deref.synopsis"></a><h5>
<a name="id931717"></a>
<a name="id938702"></a>
<a href="deref.html#fusion.iterators.functions.deref.synopsis">Synopsis</a>
</h5>
<pre class="programlisting">
@ -43,7 +43,7 @@
<span class="keyword">typename</span> <a href="../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">I</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">deref</span><span class="special">(</span><span class="identifier">I</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">i</span><span class="special">);</span>
</pre>
<div class="table">
<a name="id931843"></a><p class="title"><b>Table<EFBFBD>1.2.<2E>Parameters</b></p>
<a name="id938830"></a><p class="title"><b>Table<EFBFBD>1.2.<2E>Parameters</b></p>
<table class="table" summary="Parameters">
<colgroup>
<col>
@ -51,23 +51,45 @@
<col>
</colgroup>
<thead><tr>
<th>Parameter</th>
<th>Requirement</th>
<th>Description</th>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Requirement
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td><code class="computeroutput"><span class="identifier">i</span></code></td>
<td>Model
of <a href="../concepts/forward_iterator.html" title="Forward
<td>
<p>
<code class="computeroutput"><span class="identifier">i</span></code>
</p>
</td>
<td>
<p>
Model of <a href="../concepts/forward_iterator.html" title="Forward
Iterator">Forward
Iterator</a>
</td>
<td>Operation's argument</td>
Iterator</a>
</p>
</td>
<td>
<p>
Operation's argument
</p>
</td>
</tr></tbody>
</table>
</div>
<a name="fusion.iterators.functions.deref.expression_semantics"></a><h5>
<a name="id931908"></a>
<a name="id938921"></a>
<a href="deref.html#fusion.iterators.functions.deref.expression_semantics">Expression
Semantics</a>
</h5>
@ -82,14 +104,14 @@
<code class="computeroutput"><span class="identifier">i</span></code>.
</p>
<a name="fusion.iterators.functions.deref.header"></a><h5>
<a name="id932035"></a>
<a name="id939053"></a>
<a href="deref.html#fusion.iterators.functions.deref.header">Header</a>
</h5>
<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">iterator</span><span class="special">/</span><span class="identifier">deref</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.iterators.functions.deref.example"></a><h5>
<a name="id932117"></a>
<a name="id939136"></a>
<a href="deref.html#fusion.iterators.functions.deref.example">Example</a>
</h5>
<pre class="programlisting">

View File

@ -26,14 +26,14 @@
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.iterators.functions.distance"></a><a href="distance.html" title="distance">distance</a></h4></div></div></div>
<a name="fusion.iterators.functions.distance.description"></a><h5>
<a name="id934003"></a>
<a name="id941091"></a>
<a href="distance.html#fusion.iterators.functions.distance.description">Description</a>
</h5>
<p>
Returns the distance between 2 iterators.
</p>
<a name="fusion.iterators.functions.distance.synopsis"></a><h5>
<a name="id934029"></a>
<a name="id941117"></a>
<a href="distance.html#fusion.iterators.functions.distance.synopsis">Synopsis</a>
</h5>
<pre class="programlisting">
@ -44,7 +44,7 @@
<span class="keyword">typename</span> <a href="../metafunctions/distance.html" title="distance"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">distance</span></code></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">,</span> <span class="identifier">J</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">I</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">i</span><span class="special">,</span> <span class="identifier">J</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">j</span><span class="special">);</span>
</pre>
<div class="table">
<a name="id934205"></a><p class="title"><b>Table<EFBFBD>1.5.<2E>Parameters</b></p>
<a name="id941294"></a><p class="title"><b>Table<EFBFBD>1.5.<2E>Parameters</b></p>
<table class="table" summary="Parameters">
<colgroup>
<col>
@ -52,24 +52,45 @@
<col>
</colgroup>
<thead><tr>
<th>Parameter</th>
<th>Requirement</th>
<th>Description</th>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Requirement
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<code class="computeroutput"><span class="identifier">i</span></code>, <code class="computeroutput"><span class="identifier">j</span></code>
</td>
<td>Models of <a href="../concepts/forward_iterator.html" title="Forward
<p>
<code class="computeroutput"><span class="identifier">i</span></code>, <code class="computeroutput"><span class="identifier">j</span></code>
</p>
</td>
<td>
<p>
Models of <a href="../concepts/forward_iterator.html" title="Forward
Iterator">Forward
Iterator</a> into the same sequence</td>
<td>The start and
end points of the distance to be measured</td>
Iterator</a> into the same sequence
</p>
</td>
<td>
<p>
The start and end points of the distance to be measured
</p>
</td>
</tr></tbody>
</table>
</div>
<a name="fusion.iterators.functions.distance.expression_semantics"></a><h5>
<a name="id934280"></a>
<a name="id941396"></a>
<a href="distance.html#fusion.iterators.functions.distance.expression_semantics">Expression
Semantics</a>
</h5>
@ -84,14 +105,14 @@
iterators <code class="computeroutput"><span class="identifier">i</span></code> and <code class="computeroutput"><span class="identifier">j</span></code>.
</p>
<a name="fusion.iterators.functions.distance.header"></a><h5>
<a name="id934390"></a>
<a name="id941511"></a>
<a href="distance.html#fusion.iterators.functions.distance.header">Header</a>
</h5>
<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">iterator</span><span class="special">/</span><span class="identifier">distance</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.iterators.functions.distance.example"></a><h5>
<a name="id934473"></a>
<a name="id941596"></a>
<a href="distance.html#fusion.iterators.functions.distance.example">Example</a>
</h5>
<pre class="programlisting">

View File

@ -26,14 +26,14 @@
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.iterators.functions.next"></a><a href="next.html" title="next">next</a></h4></div></div></div>
<a name="fusion.iterators.functions.next.description"></a><h5>
<a name="id932510"></a>
<a name="id939530"></a>
<a href="next.html#fusion.iterators.functions.next.description">Description</a>
</h5>
<p>
Moves an iterator 1 position forwards.
</p>
<a name="fusion.iterators.functions.next.synopsis"></a><h5>
<a name="id932537"></a>
<a name="id939557"></a>
<a href="next.html#fusion.iterators.functions.next.synopsis">Synopsis</a>
</h5>
<pre class="programlisting">
@ -43,7 +43,7 @@
<span class="keyword">typename</span> <a href="../metafunctions/next.html" title="next"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">next</span></code></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">next</span><span class="special">(</span><span class="identifier">I</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">i</span><span class="special">);</span>
</pre>
<div class="table">
<a name="id932663"></a><p class="title"><b>Table<EFBFBD>1.3.<2E>Parameters</b></p>
<a name="id939684"></a><p class="title"><b>Table<EFBFBD>1.3.<2E>Parameters</b></p>
<table class="table" summary="Parameters">
<colgroup>
<col>
@ -51,23 +51,45 @@
<col>
</colgroup>
<thead><tr>
<th>Parameter</th>
<th>Requirement</th>
<th>Description</th>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Requirement
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td><code class="computeroutput"><span class="identifier">i</span></code></td>
<td>Model
of <a href="../concepts/forward_iterator.html" title="Forward
<td>
<p>
<code class="computeroutput"><span class="identifier">i</span></code>
</p>
</td>
<td>
<p>
Model of <a href="../concepts/forward_iterator.html" title="Forward
Iterator">Forward
Iterator</a>
</td>
<td>Operation's argument</td>
Iterator</a>
</p>
</td>
<td>
<p>
Operation's argument
</p>
</td>
</tr></tbody>
</table>
</div>
<a name="fusion.iterators.functions.next.expression_semantics"></a><h5>
<a name="id932727"></a>
<a name="id939775"></a>
<a href="next.html#fusion.iterators.functions.next.expression_semantics">Expression
Semantics</a>
</h5>
@ -83,14 +105,14 @@
next element after <code class="computeroutput"><span class="identifier">i</span></code>.
</p>
<a name="fusion.iterators.functions.next.header"></a><h5>
<a name="id932812"></a>
<a name="id939864"></a>
<a href="next.html#fusion.iterators.functions.next.header">Header</a>
</h5>
<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">iterator</span><span class="special">/</span><span class="identifier">next</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.iterators.functions.next.example"></a><h5>
<a name="id932895"></a>
<a name="id939948"></a>
<a href="next.html#fusion.iterators.functions.next.example">Example</a>
</h5>
<pre class="programlisting">

View File

@ -26,14 +26,14 @@
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.iterators.functions.prior"></a><a href="prior.html" title="prior">prior</a></h4></div></div></div>
<a name="fusion.iterators.functions.prior.description"></a><h5>
<a name="id933295"></a>
<a name="id940349"></a>
<a href="prior.html#fusion.iterators.functions.prior.description">Description</a>
</h5>
<p>
Moves an iterator 1 position backwards.
</p>
<a name="fusion.iterators.functions.prior.synopsis"></a><h5>
<a name="id933321"></a>
<a name="id940375"></a>
<a href="prior.html#fusion.iterators.functions.prior.synopsis">Synopsis</a>
</h5>
<pre class="programlisting">
@ -43,7 +43,7 @@
<span class="keyword">typename</span> <a href="../metafunctions/prior.html" title="prior"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">prior</span></code></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">prior</span><span class="special">(</span><span class="identifier">I</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">i</span><span class="special">);</span>
</pre>
<div class="table">
<a name="id933447"></a><p class="title"><b>Table<EFBFBD>1.4.<2E>Parameters</b></p>
<a name="id940502"></a><p class="title"><b>Table<EFBFBD>1.4.<2E>Parameters</b></p>
<table class="table" summary="Parameters">
<colgroup>
<col>
@ -51,23 +51,45 @@
<col>
</colgroup>
<thead><tr>
<th>Parameter</th>
<th>Requirement</th>
<th>Description</th>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Requirement
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td><code class="computeroutput"><span class="identifier">i</span></code></td>
<td>Model
of <a href="../concepts/bidirectional_iterator.html" title="Bidirectional
<td>
<p>
<code class="computeroutput"><span class="identifier">i</span></code>
</p>
</td>
<td>
<p>
Model of <a href="../concepts/bidirectional_iterator.html" title="Bidirectional
Iterator">Bidirectional
Iterator</a>
</td>
<td>Operation's argument</td>
Iterator</a>
</p>
</td>
<td>
<p>
Operation's argument
</p>
</td>
</tr></tbody>
</table>
</div>
<a name="fusion.iterators.functions.prior.expression_semantics"></a><h5>
<a name="id933513"></a>
<a name="id940594"></a>
<a href="prior.html#fusion.iterators.functions.prior.expression_semantics">Expression
Semantics</a>
</h5>
@ -83,14 +105,14 @@
element prior to <code class="computeroutput"><span class="identifier">i</span></code>.
</p>
<a name="fusion.iterators.functions.prior.header"></a><h5>
<a name="id933606"></a>
<a name="id940692"></a>
<a href="prior.html#fusion.iterators.functions.prior.header">Header</a>
</h5>
<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">iterator</span><span class="special">/</span><span class="identifier">prior</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.iterators.functions.prior.example"></a><h5>
<a name="id933689"></a>
<a name="id940776"></a>
<a href="prior.html#fusion.iterators.functions.prior.example">Example</a>
</h5>
<pre class="programlisting">