Boost.Range documentation iteration. Primarily this is the inclusion of Range Return Categories for every Range Adaptor page.

[SVN r61653]
This commit is contained in:
Neil Groves
2010-04-28 18:03:26 +00:00
parent 5364ea2cad
commit e3e1fc43d3
155 changed files with 1788 additions and 3127 deletions

View File

@ -27,7 +27,7 @@
<a name="range.reference.algorithms.numeric.accumulate"></a><a class="link" href="accumulate.html" title="accumulate"> accumulate</a>
</h5></div></div></div>
<a name="range.reference.algorithms.numeric.accumulate.prototype"></a><h6>
<a name="id2826249"></a>
<a name="id2790133"></a>
<a class="link" href="accumulate.html#range.reference.algorithms.numeric.accumulate.prototype">Prototype</a>
</h6>
<p>
@ -52,7 +52,7 @@
<p>
</p>
<a name="range.reference.algorithms.numeric.accumulate.description"></a><h6>
<a name="id2826514"></a>
<a name="id2790397"></a>
<a class="link" href="accumulate.html#range.reference.algorithms.numeric.accumulate.description">Description</a>
</h6>
<p>
@ -63,18 +63,18 @@
The return value is the resultant value of the above algorithm.
</p>
<a name="range.reference.algorithms.numeric.accumulate.definition"></a><h6>
<a name="id2826594"></a>
<a name="id2790477"></a>
<a class="link" href="accumulate.html#range.reference.algorithms.numeric.accumulate.definition">Definition</a>
</h6>
<p>
Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">numeric</span><span class="special">.</span><span class="identifier">hpp</span></code>
</p>
<a name="range.reference.algorithms.numeric.accumulate.requirements"></a><h6>
<a name="id2826658"></a>
<a name="id2790541"></a>
<a class="link" href="accumulate.html#range.reference.algorithms.numeric.accumulate.requirements">Requirements</a>
</h6>
<a name="range.reference.algorithms.numeric.accumulate.for_the_first_version"></a><h6>
<a name="id2826681"></a>
<a name="id2790565"></a>
<a class="link" href="accumulate.html#range.reference.algorithms.numeric.accumulate.for_the_first_version">For
the first version</a>
</h6>
@ -99,7 +99,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.numeric.accumulate.for_the_second_version"></a><h6>
<a name="id2826820"></a>
<a name="id2790703"></a>
<a class="link" href="accumulate.html#range.reference.algorithms.numeric.accumulate.for_the_second_version">For
the second version</a>
</h6>
@ -133,7 +133,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.numeric.accumulate.complexity"></a><h6>
<a name="id2827003"></a>
<a name="id2790887"></a>
<a class="link" href="accumulate.html#range.reference.algorithms.numeric.accumulate.complexity">Complexity</a>
</h6>
<p>

View File

@ -28,7 +28,7 @@
adjacent_difference</a>
</h5></div></div></div>
<a name="range.reference.algorithms.numeric.adjacent_difference.prototype"></a><h6>
<a name="id2827074"></a>
<a name="id2790957"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.prototype">Prototype</a>
</h6>
<p>
@ -55,7 +55,7 @@
<p>
</p>
<a name="range.reference.algorithms.numeric.adjacent_difference.description"></a><h6>
<a name="id2827342"></a>
<a name="id2791226"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.description">Description</a>
</h6>
<p>
@ -69,18 +69,18 @@
instead of <code class="computeroutput"><span class="keyword">operator</span><span class="special">-()</span></code>.
</p>
<a name="range.reference.algorithms.numeric.adjacent_difference.definition"></a><h6>
<a name="id2827449"></a>
<a name="id2791332"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.definition">Definition</a>
</h6>
<p>
Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">numeric</span><span class="special">.</span><span class="identifier">hpp</span></code>
</p>
<a name="range.reference.algorithms.numeric.adjacent_difference.requirements"></a><h6>
<a name="id2827513"></a>
<a name="id2791397"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.requirements">Requirements</a>
</h6>
<a name="range.reference.algorithms.numeric.adjacent_difference.for_the_first_version"></a><h6>
<a name="id2827538"></a>
<a name="id2791421"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.for_the_first_version">For
the first version</a>
</h6>
@ -111,7 +111,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.numeric.adjacent_difference.for_the_second_version"></a><h6>
<a name="id2827741"></a>
<a name="id2791624"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.for_the_second_version">For
the second version</a>
</h6>
@ -146,7 +146,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.numeric.adjacent_difference.precondition_"></a><h6>
<a name="id2827926"></a>
<a name="id2791810"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.precondition_">Precondition:</a>
</h6>
<p>
@ -154,7 +154,7 @@
<span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> is a valid range.
</p>
<a name="range.reference.algorithms.numeric.adjacent_difference.complexity"></a><h6>
<a name="id2828003"></a>
<a name="id2791887"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.complexity">Complexity</a>
</h6>
<p>

View File

@ -28,7 +28,7 @@
inner_product</a>
</h5></div></div></div>
<a name="range.reference.algorithms.numeric.inner_product.prototype"></a><h6>
<a name="id2828109"></a>
<a name="id2791993"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.prototype">Prototype</a>
</h6>
<p>
@ -54,7 +54,7 @@
<p>
</p>
<a name="range.reference.algorithms.numeric.inner_product.description"></a><h6>
<a name="id2828476"></a>
<a name="id2792360"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.description">Description</a>
</h6>
<p>
@ -67,18 +67,18 @@
algorithm please see <a href="http://www.sgi.com/tech/stl/inner_product.html" target="_top">inner_product</a>.
</p>
<a name="range.reference.algorithms.numeric.inner_product.definition"></a><h6>
<a name="id2828557"></a>
<a name="id2792441"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.definition">Definition</a>
</h6>
<p>
Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">numeric</span><span class="special">.</span><span class="identifier">hpp</span></code>
</p>
<a name="range.reference.algorithms.numeric.inner_product.requirements"></a><h6>
<a name="id2828622"></a>
<a name="id2792506"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.requirements">Requirements</a>
</h6>
<a name="range.reference.algorithms.numeric.inner_product.for_the_first_version"></a><h6>
<a name="id2828645"></a>
<a name="id2792529"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.for_the_first_version">For
the first version</a>
</h6>
@ -113,7 +113,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.numeric.inner_product.for_the_second_version"></a><h6>
<a name="id2828898"></a>
<a name="id2792781"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.for_the_second_version">For
the second version</a>
</h6>
@ -162,14 +162,14 @@
</li>
</ol></div>
<a name="range.reference.algorithms.numeric.inner_product.precondition_"></a><h6>
<a name="id2829183"></a>
<a name="id2793067"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.precondition_">Precondition:</a>
</h6>
<p>
<code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)</span> <span class="special">&gt;=</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span></code> is a valid range.
</p>
<a name="range.reference.algorithms.numeric.inner_product.complexity"></a><h6>
<a name="id2829259"></a>
<a name="id2793142"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.complexity">Complexity</a>
</h6>
<p>

View File

@ -28,7 +28,7 @@
partial_sum</a>
</h5></div></div></div>
<a name="range.reference.algorithms.numeric.partial_sum.prototype"></a><h6>
<a name="id2829328"></a>
<a name="id2793211"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.prototype">Prototype</a>
</h6>
<p>
@ -49,7 +49,7 @@
<p>
</p>
<a name="range.reference.algorithms.numeric.partial_sum.description"></a><h6>
<a name="id2829588"></a>
<a name="id2793472"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.description">Description</a>
</h6>
<p>
@ -58,18 +58,18 @@
in the same manner as <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">partial_sum</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">out_it</span><span class="special">)</span></code>. See <a href="http://www.sgi.com/tech/stl/partial_sum.html" target="_top">partial_sum</a>.
</p>
<a name="range.reference.algorithms.numeric.partial_sum.definition"></a><h6>
<a name="id2829729"></a>
<a name="id2793615"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.definition">Definition</a>
</h6>
<p>
Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">numeric</span><span class="special">.</span><span class="identifier">hpp</span></code>
</p>
<a name="range.reference.algorithms.numeric.partial_sum.requirements"></a><h6>
<a name="id2829794"></a>
<a name="id2793678"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.requirements">Requirements</a>
</h6>
<a name="range.reference.algorithms.numeric.partial_sum.for_the_first_version"></a><h6>
<a name="id2829817"></a>
<a name="id2793701"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.for_the_first_version">For
the first version</a>
</h6>
@ -99,7 +99,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.numeric.partial_sum.for_the_second_version"></a><h6>
<a name="id2830019"></a>
<a name="id2793904"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.for_the_second_version">For
the second version</a>
</h6>
@ -128,7 +128,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.numeric.partial_sum.precondition_"></a><h6>
<a name="id2830180"></a>
<a name="id2794063"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.precondition_">Precondition:</a>
</h6>
<p>
@ -136,7 +136,7 @@
<span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> is a valid range.
</p>
<a name="range.reference.algorithms.numeric.partial_sum.complexity"></a><h6>
<a name="id2830256"></a>
<a name="id2794139"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.complexity">Complexity</a>
</h6>
<p>