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

22
doc/html/fusion/iterators/operators/operator_equality.html
View File

@ -4,7 +4,7 @@
<title> Operator
==</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="../operators.html" title="Operators">
<link rel="prev" href="operator_unary_star.html" title=" Operator
@ -31,14 +31,14 @@
=="> Operator
==</a></h4></div></div></div>
<a name="fusion.iterators.operators.operator_equality.description"></a><h5>
<a name="id469661"></a>
<a name="id937013"></a>
<a href="operator_equality.html#fusion.iterators.operators.operator_equality.description">Description</a>
</h5>
<p>
Compares 2 iterators for equality.
</p>
<a name="fusion.iterators.operators.operator_equality.synopsis"></a><h5>
<a name="id469692"></a>
<a name="id937041"></a>
<a href="operator_equality.html#fusion.iterators.operators.operator_equality.synopsis">Synopsis</a>
</h5>
<pre class="programlisting">
@ -49,7 +49,7 @@
<span class="emphasis"><em>unspecified</em></span> <span class="keyword">operator</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">i</span><span class="special">);</span>
</pre>
<div class="table">
<a name="id469833"></a><p class="title"><b>Table<EFBFBD>1.9.<2E>Parameters</b></p>
<a name="id937165"></a><p class="title"><b>Table<EFBFBD>1.9.<2E>Parameters</b></p>
<table class="table" summary="Parameters">
<colgroup>
<col>
@ -63,7 +63,7 @@
</tr></thead>
<tbody><tr>
<td>
<tt class="computeroutput"><span class="identifier">i</span></tt>, <tt class="computeroutput"><span class="identifier">j</span></tt>
<code class="computeroutput"><span class="identifier">i</span></code>, <code class="computeroutput"><span class="identifier">j</span></code>
</td>
<td>Any fusion iterators</td>
<td>Operation's
@ -72,7 +72,7 @@
</table>
</div>
<a name="fusion.iterators.operators.operator_equality.expression_semantics"></a><h5>
<a name="id469909"></a>
<a name="id937234"></a>
<a href="operator_equality.html#fusion.iterators.operators.operator_equality.expression_semantics">Expression
Semantics</a>
</h5>
@ -80,15 +80,15 @@
<span class="identifier">i</span> <span class="special">==</span> <span class="identifier">j</span>
</pre>
<p>
<span class="bold"><b>Return type</b></span>: Convertible to <tt class="computeroutput"><span class="keyword">bool</span></tt>.
<span class="bold"><strong>Return type</strong></span>: Convertible to <code class="computeroutput"><span class="keyword">bool</span></code>.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Equivalent to <tt class="computeroutput"><a href="../metafunctions/equal_to.html" title="equal_to"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">equal_to</span></tt></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">value</span></tt>
where <tt class="computeroutput"><span class="identifier">I</span></tt> and <tt class="computeroutput"><span class="identifier">J</span></tt> are the types of <tt class="computeroutput"><span class="identifier">i</span></tt>
and <tt class="computeroutput"><span class="identifier">j</span></tt> respectively.
<span class="bold"><strong>Semantics</strong></span>: Equivalent to <code class="computeroutput"><a href="../metafunctions/equal_to.html" title="equal_to"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">equal_to</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">value</span></code>
where <code class="computeroutput"><span class="identifier">I</span></code> and <code class="computeroutput"><span class="identifier">J</span></code> are the types of <code class="computeroutput"><span class="identifier">i</span></code>
and <code class="computeroutput"><span class="identifier">j</span></code> respectively.
</p>
<a name="fusion.iterators.operators.operator_equality.header"></a><h5>
<a name="id470092"></a>
<a name="id937395"></a>
<a href="operator_equality.html#fusion.iterators.operators.operator_equality.header">Header</a>
</h5>
<pre class="programlisting">

22
doc/html/fusion/iterators/operators/operator_inequality.html
View File

@ -4,7 +4,7 @@
<title> Operator
!=</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="../operators.html" title="Operators">
<link rel="prev" href="operator_equality.html" title=" Operator
@ -30,14 +30,14 @@
!="> Operator
!=</a></h4></div></div></div>
<a name="fusion.iterators.operators.operator_inequality.description"></a><h5>
<a name="id470210"></a>
<a name="id937499"></a>
<a href="operator_inequality.html#fusion.iterators.operators.operator_inequality.description">Description</a>
</h5>
<p>
Compares 2 iterators for inequality.
</p>
<a name="fusion.iterators.operators.operator_inequality.synopsis"></a><h5>
<a name="id470242"></a>
<a name="id937527"></a>
<a href="operator_inequality.html#fusion.iterators.operators.operator_inequality.synopsis">Synopsis</a>
</h5>
<pre class="programlisting">
@ -48,7 +48,7 @@
<span class="emphasis"><em>unspecified</em></span> <span class="keyword">operator</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">i</span><span class="special">);</span>
</pre>
<div class="table">
<a name="id470384"></a><p class="title"><b>Table<EFBFBD>1.10.<2E>Parameters</b></p>
<a name="id937652"></a><p class="title"><b>Table<EFBFBD>1.10.<2E>Parameters</b></p>
<table class="table" summary="Parameters">
<colgroup>
<col>
@ -62,7 +62,7 @@
</tr></thead>
<tbody><tr>
<td>
<tt class="computeroutput"><span class="identifier">i</span></tt>, <tt class="computeroutput"><span class="identifier">j</span></tt>
<code class="computeroutput"><span class="identifier">i</span></code>, <code class="computeroutput"><span class="identifier">j</span></code>
</td>
<td>Any fusion iterators</td>
<td>Operation's
@ -71,20 +71,20 @@
</table>
</div>
<a name="fusion.iterators.operators.operator_inequality.expression_semantics"></a><h5>
<a name="id470458"></a>
<a name="id937721"></a>
<a href="operator_inequality.html#fusion.iterators.operators.operator_inequality.expression_semantics">Expression
Semantics</a>
</h5>
<p>
<span class="bold"><b>Return type</b></span>: Convertible to <tt class="computeroutput"><span class="keyword">bool</span></tt>.
<span class="bold"><strong>Return type</strong></span>: Convertible to <code class="computeroutput"><span class="keyword">bool</span></code>.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Equivalent to <tt class="computeroutput"><span class="special">!</span><a href="../metafunctions/equal_to.html" title="equal_to"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">equal_to</span></tt></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">value</span></tt>
where <tt class="computeroutput"><span class="identifier">I</span></tt> and <tt class="computeroutput"><span class="identifier">J</span></tt> are the types of <tt class="computeroutput"><span class="identifier">i</span></tt>
and <tt class="computeroutput"><span class="identifier">j</span></tt> respectively.
<span class="bold"><strong>Semantics</strong></span>: Equivalent to <code class="computeroutput"><span class="special">!</span><a href="../metafunctions/equal_to.html" title="equal_to"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">equal_to</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">value</span></code>
where <code class="computeroutput"><span class="identifier">I</span></code> and <code class="computeroutput"><span class="identifier">J</span></code> are the types of <code class="computeroutput"><span class="identifier">i</span></code>
and <code class="computeroutput"><span class="identifier">j</span></code> respectively.
</p>
<a name="fusion.iterators.operators.operator_inequality.header"></a><h5>
<a name="id470622"></a>
<a name="id937864"></a>
<a href="operator_inequality.html#fusion.iterators.operators.operator_inequality.header">Header</a>
</h5>
<pre class="programlisting">

32
doc/html/fusion/iterators/operators/operator_unary_star.html
View File

@ -4,7 +4,7 @@
<title> Operator
*</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="../operators.html" title="Operators">
<link rel="prev" href="../operators.html" title="Operators">
@ -30,24 +30,24 @@
*"> Operator
*</a></h4></div></div></div>
<a name="fusion.iterators.operators.operator_unary_star.description"></a><h5>
<a name="id468777"></a>
<a name="id936233"></a>
<a href="operator_unary_star.html#fusion.iterators.operators.operator_unary_star.description">Description</a>
</h5>
<p>
Dereferences an iterator.
</p>
<a name="fusion.iterators.operators.operator_unary_star.synopsis"></a><h5>
<a name="id468807"></a>
<a name="id936260"></a>
<a href="operator_unary_star.html#fusion.iterators.operators.operator_unary_star.synopsis">Synopsis</a>
</h5>
<pre class="programlisting">
<span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <span class="identifier">I</span>
<span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../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">I</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="keyword">operator</span><span class="special">*(</span><span class="emphasis"><em>unspecified</em></span><span class="special">&lt;</span><span class="identifier">I</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">i</span><span class="special">);</span>
<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="keyword">operator</span><span class="special">*(</span><span class="emphasis"><em>unspecified</em></span><span class="special">&lt;</span><span class="identifier">I</span><span class="special">&gt;</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="id468964"></a><p class="title"><b>Table<EFBFBD>1.8.<2E>Parameters</b></p>
<a name="id936398"></a><p class="title"><b>Table<EFBFBD>1.8.<2E>Parameters</b></p>
<table class="table" summary="Parameters">
<colgroup>
<col>
@ -60,7 +60,7 @@
<th>Description</th>
</tr></thead>
<tbody><tr>
<td><tt class="computeroutput"><span class="identifier">i</span></tt></td>
<td><code class="computeroutput"><span class="identifier">i</span></code></td>
<td>Model
of <a href="../concepts/forward_iterator.html" title="Forward
Iterator">Forward
@ -71,7 +71,7 @@
</table>
</div>
<a name="fusion.iterators.operators.operator_unary_star.expression_semantics"></a><h5>
<a name="id469039"></a>
<a name="id936465"></a>
<a href="operator_unary_star.html#fusion.iterators.operators.operator_unary_star.expression_semantics">Expression
Semantics</a>
</h5>
@ -79,31 +79,31 @@
<span class="special">*</span><span class="identifier">i</span>
</pre>
<p>
<span class="bold"><b>Return type</b></span>: Equivalent to the return
type of <tt class="computeroutput"><a href="../functions/deref.html" title="deref"><tt class="computeroutput"><span class="identifier">deref</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></tt>.
<span class="bold"><strong>Return type</strong></span>: Equivalent to the return
type of <code class="computeroutput"><a href="../functions/deref.html" title="deref"><code class="computeroutput"><span class="identifier">deref</span></code></a><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></code>.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Equivalent to <tt class="computeroutput"><a href="../functions/deref.html" title="deref"><tt class="computeroutput"><span class="identifier">deref</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></tt>.
<span class="bold"><strong>Semantics</strong></span>: Equivalent to <code class="computeroutput"><a href="../functions/deref.html" title="deref"><code class="computeroutput"><span class="identifier">deref</span></code></a><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></code>.
</p>
<a name="fusion.iterators.operators.operator_unary_star.header"></a><h5>
<a name="id469173"></a>
<a name="id936583"></a>
<a href="operator_unary_star.html#fusion.iterators.operators.operator_unary_star.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.operators.operator_unary_star.example"></a><h5>
<a name="id469268"></a>
<a name="id936667"></a>
<a href="operator_unary_star.html#fusion.iterators.operators.operator_unary_star.example">Example</a>
</h5>
<pre class="programlisting">
<span class="keyword">typedef</span> <a href="../../sequences/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">,</span><span class="keyword">int</span><span class="special">&amp;&gt;</span> <span class="identifier">vec</span><span class="special">;</span>
<span class="keyword">typedef</span> <a href="../../sequences/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">,</span><span class="keyword">int</span><span class="special">&amp;&gt;</span> <span class="identifier">vec</span><span class="special">;</span>
<span class="keyword">int</span> <span class="identifier">i</span><span class="special">(</span><span class="number">0</span><span class="special">);</span>
<span class="identifier">vec</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span><span class="identifier">i</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(*</span><a href="../../sequences/intrinsics/functions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">begin</span></tt></a><span class="special">(</span><span class="identifier">v</span><span class="special">)</span> <span class="special">==</span> <span class="number">1</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(*</span><a href="../functions/next.html" title="next"><tt class="computeroutput"><span class="identifier">next</span></tt></a><span class="special">(</span><a href="../../sequences/intrinsics/functions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">begin</span></tt></a><span class="special">(</span><span class="identifier">v</span><span class="special">))</span> <span class="special">==</span> <span class="number">0</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(&amp;(*</span><a href="../functions/next.html" title="next"><tt class="computeroutput"><span class="identifier">next</span></tt></a><span class="special">(</span><a href="../../sequences/intrinsics/functions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">begin</span></tt></a><span class="special">(</span><span class="identifier">v</span><span class="special">)))</span> <span class="special">==</span> <span class="special">&amp;</span><span class="identifier">i</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(*</span><a href="../../sequences/intrinsics/functions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">begin</span></code></a><span class="special">(</span><span class="identifier">v</span><span class="special">)</span> <span class="special">==</span> <span class="number">1</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(*</span><a href="../functions/next.html" title="next"><code class="computeroutput"><span class="identifier">next</span></code></a><span class="special">(</span><a href="../../sequences/intrinsics/functions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">begin</span></code></a><span class="special">(</span><span class="identifier">v</span><span class="special">))</span> <span class="special">==</span> <span class="number">0</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(&amp;(*</span><a href="../functions/next.html" title="next"><code class="computeroutput"><span class="identifier">next</span></code></a><span class="special">(</span><a href="../../sequences/intrinsics/functions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">begin</span></code></a><span class="special">(</span><span class="identifier">v</span><span class="special">)))</span> <span class="special">==</span> <span class="special">&amp;</span><span class="identifier">i</span><span class="special">);</span>
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>