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>find</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="none.html" title="none">
@ -26,15 +26,15 @@
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.algorithms.query.metafunctions.find"></a><a href="find.html" title="find">find</a></h5></div></div></div>
<a name="fusion.algorithms.query.metafunctions.find.description"></a><h6>
<a name="id569192"></a>
<a name="id1111947"></a>
<a href="find.html#fusion.algorithms.query.metafunctions.find.description">Description</a>
</h6>
<p>
Returns the result type of <tt class="computeroutput"><span class="identifier">find</span></tt>,
Returns the result type of <code class="computeroutput"><span class="identifier">find</span></code>,
given the sequence and search types.
</p>
<a name="fusion.algorithms.query.metafunctions.find.synopsis"></a><h6>
<a name="id569234"></a>
<a name="id1111985"></a>
<a href="find.html#fusion.algorithms.query.metafunctions.find.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
@ -48,7 +48,7 @@
<span class="special">};</span>
</pre>
<div class="table">
<a name="id569351"></a><p class="title"><b>Table<EFBFBD>1.48.<2E>Parameters</b></p>
<a name="id1112088"></a><p class="title"><b>Table<EFBFBD>1.48.<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">Sequence</span></tt></td>
<td><code class="computeroutput"><span class="identifier">Sequence</span></code></td>
<td>Model
of <a href="../../../sequences/concepts/forward_sequence.html" title="Forward
Sequence">Forward
@ -71,7 +71,7 @@
<td>Operation's argument</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">T</span></tt></td>
<td><code class="computeroutput"><span class="identifier">T</span></code></td>
<td>Any
type</td>
<td>Operation's argument</td>
@ -80,31 +80,31 @@
</table>
</div>
<a name="fusion.algorithms.query.metafunctions.find.expression_semantics"></a><h6>
<a name="id569445"></a>
<a name="id1112172"></a>
<a href="find.html#fusion.algorithms.query.metafunctions.find.expression_semantics">Expression
Semantics</a>
</h6>
<pre class="programlisting">
<a href="find.html" title="find"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">find</span></tt></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">,</span> <span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">type</span>
<a href="find.html" title="find"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">find</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">,</span> <span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">type</span>
</pre>
<p>
<span class="bold"><b>Return type</b></span>: A model of the same iterator
category as the iterators of <tt class="computeroutput"><span class="identifier">Sequence</span></tt>.
<span class="bold"><strong>Return type</strong></span>: A model of the same iterator
category as the iterators of <code class="computeroutput"><span class="identifier">Sequence</span></code>.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Returns an iterator to the
first element of type <tt class="computeroutput"><span class="identifier">T</span></tt>
in <tt class="computeroutput"><span class="identifier">Sequence</span></tt>, or <tt class="computeroutput"><a href="../../../sequences/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">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span></tt> if there is no such element.
<span class="bold"><strong>Semantics</strong></span>: Returns an iterator to the
first element of type <code class="computeroutput"><span class="identifier">T</span></code>
in <code class="computeroutput"><span class="identifier">Sequence</span></code>, or <code class="computeroutput"><a href="../../../sequences/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">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span></code> if there is no such element.
</p>
<a name="fusion.algorithms.query.metafunctions.find.complexity"></a><h6>
<a name="id569641"></a>
<a name="id1112344"></a>
<a href="find.html#fusion.algorithms.query.metafunctions.find.complexity">Complexity</a>
</h6>
<p>
Linear, at most <tt class="computeroutput"><a href="../../../sequences/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">Sequence</span><span class="special">&gt;::</span><span class="identifier">value</span></tt> comparisons.
Linear, at most <code class="computeroutput"><a href="../../../sequences/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">Sequence</span><span class="special">&gt;::</span><span class="identifier">value</span></code> comparisons.
</p>
<a name="fusion.algorithms.query.metafunctions.find.header"></a><h6>
<a name="id569723"></a>
<a name="id1112417"></a>
<a href="find.html#fusion.algorithms.query.metafunctions.find.header">Header</a>
</h6>
<pre class="programlisting">