feedc0de/boost_range
1
0
Fork 0
forked from boostorg/range
Code Pull Requests Activity

[boost][range] - Added documentation for the join() function. This is to resolve Trac ticket 4740.

Browse Source 
[SVN r67428]
This commit is contained in:
Neil Groves
2010-12-23 10:56:23 +00:00
parent c66fb8e807
commit 48fc316156
93 changed files with 543 additions and 494 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/html/range/reference/algorithms/numeric/accumulate.html
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="id723065"></a>
<a name="id765356"></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="id723327"></a>
<a name="id765618"></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="id723401"></a>
<a name="id765692"></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="id723463"></a>
<a name="id765755"></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="id723484"></a>
<a name="id765776"></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="id723627"></a>
<a name="id765918"></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="id723819"></a>
<a name="id766110"></a>
<a class="link" href="accumulate.html#range.reference.algorithms.numeric.accumulate.complexity">Complexity</a>
</h6>
<p>

16
doc/html/range/reference/algorithms/numeric/adjacent_difference.html
View File

@ -27,7 +27,7 @@
<a name="range.reference.algorithms.numeric.adjacent_difference"></a><a class="link" href="adjacent_difference.html" title="adjacent_difference">adjacent_difference</a>
</h5></div></div></div>
<a name="range.reference.algorithms.numeric.adjacent_difference.prototype"></a><h6>
<a name="id723885"></a>
<a name="id766176"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.prototype">Prototype</a>
</h6>
<p>
@ -54,7 +54,7 @@
<p>
</p>
<a name="range.reference.algorithms.numeric.adjacent_difference.description"></a><h6>
<a name="id724149"></a>
<a name="id766440"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.description">Description</a>
</h6>
<p>
@ -68,18 +68,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="id724249"></a>
<a name="id766540"></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="id724311"></a>
<a name="id766602"></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="id724332"></a>
<a name="id766623"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.for_the_first_version">For
the first version</a>
</h6>
@ -110,7 +110,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.numeric.adjacent_difference.for_the_second_version"></a><h6>
<a name="id724540"></a>
<a name="id766831"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.for_the_second_version">For
the second version</a>
</h6>
@ -145,7 +145,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.numeric.adjacent_difference.precondition_"></a><h6>
<a name="id724734"></a>
<a name="id767025"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.precondition_">Precondition:</a>
</h6>
<p>
@ -153,7 +153,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="id724807"></a>
<a name="id767098"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.complexity">Complexity</a>
</h6>
<p>

16
doc/html/range/reference/algorithms/numeric/inner_product.html
View File

@ -27,7 +27,7 @@
<a name="range.reference.algorithms.numeric.inner_product"></a><a class="link" href="inner_product.html" title="inner_product">inner_product</a>
</h5></div></div></div>
<a name="range.reference.algorithms.numeric.inner_product.prototype"></a><h6>
<a name="id724907"></a>
<a name="id767198"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.prototype">Prototype</a>
</h6>
<p>
@ -53,7 +53,7 @@
<p>
</p>
<a name="range.reference.algorithms.numeric.inner_product.description"></a><h6>
<a name="id725270"></a>
<a name="id767562"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.description">Description</a>
</h6>
<p>
@ -66,18 +66,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="id725347"></a>
<a name="id767638"></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="id725408"></a>
<a name="id767699"></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="id725429"></a>
<a name="id767720"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.for_the_first_version">For
the first version</a>
</h6>
@ -112,7 +112,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.numeric.inner_product.for_the_second_version"></a><h6>
<a name="id725686"></a>
<a name="id767977"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.for_the_second_version">For
the second version</a>
</h6>
@ -161,14 +161,14 @@
</li>
</ol></div>
<a name="range.reference.algorithms.numeric.inner_product.precondition_"></a><h6>
<a name="id725987"></a>
<a name="id768278"></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="id726059"></a>
<a name="id768350"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.complexity">Complexity</a>
</h6>
<p>

16
doc/html/range/reference/algorithms/numeric/partial_sum.html
View File

@ -27,7 +27,7 @@
<a name="range.reference.algorithms.numeric.partial_sum"></a><a class="link" href="partial_sum.html" title="partial_sum">partial_sum</a>
</h5></div></div></div>
<a name="range.reference.algorithms.numeric.partial_sum.prototype"></a><h6>
<a name="id726125"></a>
<a name="id768417"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.prototype">Prototype</a>
</h6>
<p>
@ -48,7 +48,7 @@
<p>
</p>
<a name="range.reference.algorithms.numeric.partial_sum.description"></a><h6>
<a name="id726383"></a>
<a name="id768674"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.description">Description</a>
</h6>
<p>
@ -57,18 +57,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="id726522"></a>
<a name="id768813"></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="id726584"></a>
<a name="id768875"></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="id726604"></a>
<a name="id768895"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.for_the_first_version">For
the first version</a>
</h6>
@ -98,7 +98,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.numeric.partial_sum.for_the_second_version"></a><h6>
<a name="id726811"></a>
<a name="id769103"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.for_the_second_version">For
the second version</a>
</h6>
@ -127,7 +127,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.numeric.partial_sum.precondition_"></a><h6>
<a name="id726976"></a>
<a name="id769268"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.precondition_">Precondition:</a>
</h6>
<p>
@ -135,7 +135,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="id727050"></a>
<a name="id769341"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.numeric.partial_sum.complexity">Complexity</a>
</h6>
<p>