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

Boost.Range minor documentation corrections and code comment fixes.

Browse Source 
[SVN r61014]
This commit is contained in:
Neil Groves
2010-04-03 09:02:21 +00:00
parent 629ab6adbf
commit b4ae711d4e
91 changed files with 534 additions and 533 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/html/range/reference/algorithms/range_numeric/accumulate.html
View File

@ -28,7 +28,7 @@
accumulate</a>
</h5></div></div></div>
<a name="range.reference.algorithms.range_numeric.accumulate.prototype"></a><h6>
<a name="id3259323"></a>
<a name="id3005906"></a>
<a class="link" href="accumulate.html#range.reference.algorithms.range_numeric.accumulate.prototype">Prototype</a>
</h6>
<p>
@ -53,7 +53,7 @@
<p>
</p>
<a name="range.reference.algorithms.range_numeric.accumulate.description"></a><h6>
<a name="id3259589"></a>
<a name="id3006172"></a>
<a class="link" href="accumulate.html#range.reference.algorithms.range_numeric.accumulate.description">Description</a>
</h6>
<p>
@ -64,18 +64,18 @@
The return value is the resultant value of the above algorithm.
</p>
<a name="range.reference.algorithms.range_numeric.accumulate.definition"></a><h6>
<a name="id3259669"></a>
<a name="id3006252"></a>
<a class="link" href="accumulate.html#range.reference.algorithms.range_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.range_numeric.accumulate.requirements"></a><h6>
<a name="id3259733"></a>
<a name="id3006316"></a>
<a class="link" href="accumulate.html#range.reference.algorithms.range_numeric.accumulate.requirements">Requirements</a>
</h6>
<a name="range.reference.algorithms.range_numeric.accumulate.for_the_first_version"></a><h6>
<a name="id3259756"></a>
<a name="id3006339"></a>
<a class="link" href="accumulate.html#range.reference.algorithms.range_numeric.accumulate.for_the_first_version">For
the first version</a>
</h6>
@ -100,7 +100,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.range_numeric.accumulate.for_the_second_version"></a><h6>
<a name="id3259894"></a>
<a name="id3006477"></a>
<a class="link" href="accumulate.html#range.reference.algorithms.range_numeric.accumulate.for_the_second_version">For
the second version</a>
</h6>
@ -134,7 +134,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.range_numeric.accumulate.complexity"></a><h6>
<a name="id3260078"></a>
<a name="id3006661"></a>
<a class="link" href="accumulate.html#range.reference.algorithms.range_numeric.accumulate.complexity">Complexity</a>
</h6>
<p>

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

@ -28,7 +28,7 @@
adjacent_difference</a>
</h5></div></div></div>
<a name="range.reference.algorithms.range_numeric.adjacent_difference.prototype"></a><h6>
<a name="id3260149"></a>
<a name="id3006732"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.range_numeric.adjacent_difference.prototype">Prototype</a>
</h6>
<p>
@ -55,7 +55,7 @@
<p>
</p>
<a name="range.reference.algorithms.range_numeric.adjacent_difference.description"></a><h6>
<a name="id3260417"></a>
<a name="id3007000"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.range_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.range_numeric.adjacent_difference.definition"></a><h6>
<a name="id3260522"></a>
<a name="id3007105"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.range_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.range_numeric.adjacent_difference.requirements"></a><h6>
<a name="id3260587"></a>
<a name="id3007170"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.range_numeric.adjacent_difference.requirements">Requirements</a>
</h6>
<a name="range.reference.algorithms.range_numeric.adjacent_difference.for_the_first_version"></a><h6>
<a name="id3260611"></a>
<a name="id3007194"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.range_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.range_numeric.adjacent_difference.for_the_second_version"></a><h6>
<a name="id3260814"></a>
<a name="id3007397"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.range_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.range_numeric.adjacent_difference.precondition_"></a><h6>
<a name="id3261002"></a>
<a name="id3007585"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.range_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.range_numeric.adjacent_difference.complexity"></a><h6>
<a name="id3261079"></a>
<a name="id3007662"></a>
<a class="link" href="adjacent_difference.html#range.reference.algorithms.range_numeric.adjacent_difference.complexity">Complexity</a>
</h6>
<p>

20
doc/html/range/reference/algorithms/range_numeric/inner_product.html
View File

@ -28,7 +28,7 @@
inner_product</a>
</h5></div></div></div>
<a name="range.reference.algorithms.range_numeric.inner_product.prototype"></a><h6>
<a name="id3261186"></a>
<a name="id3007769"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.range_numeric.inner_product.prototype">Prototype</a>
</h6>
<p>
@ -39,7 +39,7 @@
<span class="keyword">class</span> <span class="identifier">Value</span><span class="special">&gt;</span>
<span class="identifier">Value</span> <span class="identifier">inner_product</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&amp;</span> <span class="identifier">rng1</span><span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&amp;</span> <span class="identifier">rng2</span><span class="special">,</span>
<span class="identifier">Value</span> <span class="identifier">init</span><span class="special">);</span>
<span class="identifier">Value</span> <span class="identifier">init</span> <span class="special">);</span>
<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span>
<span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span>
@ -49,12 +49,12 @@
<span class="identifier">Value</span> <span class="identifier">inner_product</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&amp;</span> <span class="identifier">rng1</span><span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&amp;</span> <span class="identifier">rng2</span><span class="special">,</span>
<span class="identifier">Value</span> <span class="identifier">init</span><span class="special">,</span>
<span class="identifier">BinaryOperation1</span> <span class="identifier">op1</span><span class="special">,</span>
<span class="identifier">BinaryOperation1</span> <span class="identifier">op1</span> <span class="special">);</span>
</pre>
<p>
</p>
<a name="range.reference.algorithms.range_numeric.inner_product.description"></a><h6>
<a name="id3261550"></a>
<a name="id3008135"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.range_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.range_numeric.inner_product.definition"></a><h6>
<a name="id3261632"></a>
<a name="id3008217"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.range_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.range_numeric.inner_product.requirements"></a><h6>
<a name="id3261697"></a>
<a name="id3008282"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.range_numeric.inner_product.requirements">Requirements</a>
</h6>
<a name="range.reference.algorithms.range_numeric.inner_product.for_the_first_version"></a><h6>
<a name="id3261721"></a>
<a name="id3008306"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.range_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.range_numeric.inner_product.for_the_second_version"></a><h6>
<a name="id3261975"></a>
<a name="id3008560"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.range_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.range_numeric.inner_product.precondition_"></a><h6>
<a name="id3262261"></a>
<a name="id3008846"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.range_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.range_numeric.inner_product.complexity"></a><h6>
<a name="id3262338"></a>
<a name="id3008923"></a>
<a class="link" href="inner_product.html#range.reference.algorithms.range_numeric.inner_product.complexity">Complexity</a>
</h6>
<p>

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

@ -28,7 +28,7 @@
partial_sum</a>
</h5></div></div></div>
<a name="range.reference.algorithms.range_numeric.partial_sum.prototype"></a><h6>
<a name="id3262409"></a>
<a name="id3008994"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.range_numeric.partial_sum.prototype">Prototype</a>
</h6>
<p>
@ -49,7 +49,7 @@
<p>
</p>
<a name="range.reference.algorithms.range_numeric.partial_sum.description"></a><h6>
<a name="id3262670"></a>
<a name="id3009255"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.range_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.range_numeric.partial_sum.definition"></a><h6>
<a name="id3262813"></a>
<a name="id3009398"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.range_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.range_numeric.partial_sum.requirements"></a><h6>
<a name="id3262877"></a>
<a name="id3009462"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.range_numeric.partial_sum.requirements">Requirements</a>
</h6>
<a name="range.reference.algorithms.range_numeric.partial_sum.for_the_first_version"></a><h6>
<a name="id3262900"></a>
<a name="id3009486"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.range_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.range_numeric.partial_sum.for_the_second_version"></a><h6>
<a name="id3263103"></a>
<a name="id3009688"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.range_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.range_numeric.partial_sum.precondition_"></a><h6>
<a name="id3263262"></a>
<a name="id3009847"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.range_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.range_numeric.partial_sum.complexity"></a><h6>
<a name="id3263338"></a>
<a name="id3009923"></a>
<a class="link" href="partial_sum.html#range.reference.algorithms.range_numeric.partial_sum.complexity">Complexity</a>
</h6>
<p>