[boost][range] - Resolution of Trac ticket 4355. Made the naming of the returned types from range adaptors consistent and documented.

[SVN r67420]
This commit is contained in:
Neil Groves
2010-12-22 23:42:02 +00:00
parent d68174a51d
commit dfa0764d53
127 changed files with 630 additions and 576 deletions

View File

@ -27,7 +27,7 @@
<a name="range.reference.algorithms.new.copy_n"></a><a class="link" href="copy_n.html" title="copy_n">copy_n</a>
</h5></div></div></div>
<a name="range.reference.algorithms.new.copy_n.prototype"></a><h6>
<a name="id759588"></a>
<a name="id717053"></a>
<a class="link" href="copy_n.html#range.reference.algorithms.new.copy_n.prototype">Prototype</a>
</h6>
<p>
@ -39,7 +39,7 @@
<p>
</p>
<a name="range.reference.algorithms.new.copy_n.description"></a><h6>
<a name="id759746"></a>
<a name="id717212"></a>
<a class="link" href="copy_n.html#range.reference.algorithms.new.copy_n.description">Description</a>
</h6>
<p>
@ -53,14 +53,14 @@
from <code class="computeroutput"><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">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">n</span><span class="special">)</span></code> to the range <code class="computeroutput"><span class="special">[</span><span class="identifier">out</span><span class="special">,</span> <span class="identifier">out</span> <span class="special">+</span> <span class="identifier">n</span><span class="special">)</span></code>
</p>
<a name="range.reference.algorithms.new.copy_n.definition"></a><h6>
<a name="id759915"></a>
<a name="id717382"></a>
<a class="link" href="copy_n.html#range.reference.algorithms.new.copy_n.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">algorithm_ext</span><span class="special">/</span><span class="identifier">copy_n</span><span class="special">.</span><span class="identifier">hpp</span></code>
</p>
<a name="range.reference.algorithms.new.copy_n.requirements"></a><h6>
<a name="id759986"></a>
<a name="id717452"></a>
<a class="link" href="copy_n.html#range.reference.algorithms.new.copy_n.requirements">Requirements</a>
</h6>
<div class="orderedlist"><ol class="orderedlist" type="1">
@ -79,7 +79,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.new.copy_n.complexity"></a><h6>
<a name="id760094"></a>
<a name="id717560"></a>
<a class="link" href="copy_n.html#range.reference.algorithms.new.copy_n.complexity">Complexity</a>
</h6>
<p>

View File

@ -27,7 +27,7 @@
<a name="range.reference.algorithms.new.erase"></a><a class="link" href="erase.html" title="erase">erase</a>
</h5></div></div></div>
<a name="range.reference.algorithms.new.erase.prototype"></a><h6>
<a name="id760145"></a>
<a name="id717612"></a>
<a class="link" href="erase.html#range.reference.algorithms.new.erase.prototype">Prototype</a>
</h6>
<p>
@ -41,7 +41,7 @@
<p>
</p>
<a name="range.reference.algorithms.new.erase.description"></a><h6>
<a name="id760285"></a>
<a name="id717752"></a>
<a class="link" href="erase.html#range.reference.algorithms.new.erase.description">Description</a>
</h6>
<p>
@ -58,14 +58,14 @@
the frequently used combination equivalent to <code class="computeroutput"><span class="identifier">target</span><span class="special">.</span><span class="identifier">erase</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">remove_if</span><span class="special">(</span><span class="identifier">target</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">target</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span> <span class="identifier">pred</span><span class="special">),</span> <span class="identifier">target</span><span class="special">.</span><span class="identifier">end</span><span class="special">());</span></code>
</p>
<a name="range.reference.algorithms.new.erase.definition"></a><h6>
<a name="id760584"></a>
<a name="id718051"></a>
<a class="link" href="erase.html#range.reference.algorithms.new.erase.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">algorithm_ext</span><span class="special">/</span><span class="identifier">erase</span><span class="special">.</span><span class="identifier">hpp</span></code>
</p>
<a name="range.reference.algorithms.new.erase.requirements"></a><h6>
<a name="id760653"></a>
<a name="id718120"></a>
<a class="link" href="erase.html#range.reference.algorithms.new.erase.requirements">Requirements</a>
</h6>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
@ -73,7 +73,7 @@
erase of an iterator range.
</li></ol></div>
<a name="range.reference.algorithms.new.erase.complexity"></a><h6>
<a name="id760698"></a>
<a name="id718165"></a>
<a class="link" href="erase.html#range.reference.algorithms.new.erase.complexity">Complexity</a>
</h6>
<p>

View File

@ -27,7 +27,7 @@
<a name="range.reference.algorithms.new.for_each"></a><a class="link" href="for_each.html" title="for_each">for_each</a>
</h5></div></div></div>
<a name="range.reference.algorithms.new.for_each.prototype"></a><h6>
<a name="id760762"></a>
<a name="id718229"></a>
<a class="link" href="for_each.html#range.reference.algorithms.new.for_each.prototype">Prototype</a>
</h6>
<p>
@ -72,7 +72,7 @@
<p>
</p>
<a name="range.reference.algorithms.new.for_each.description"></a><h6>
<a name="id761337"></a>
<a name="id718804"></a>
<a class="link" href="for_each.html#range.reference.algorithms.new.for_each.description">Description</a>
</h6>
<p>
@ -88,14 +88,14 @@
It is safe to call this function with unequal length ranges.
</p>
<a name="range.reference.algorithms.new.for_each.definition"></a><h6>
<a name="id761492"></a>
<a name="id718959"></a>
<a class="link" href="for_each.html#range.reference.algorithms.new.for_each.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">algorithm_ext</span><span class="special">/</span><span class="identifier">for_each</span><span class="special">.</span><span class="identifier">hpp</span></code>
</p>
<a name="range.reference.algorithms.new.for_each.requirements"></a><h6>
<a name="id761563"></a>
<a name="id719030"></a>
<a class="link" href="for_each.html#range.reference.algorithms.new.for_each.requirements">Requirements</a>
</h6>
<div class="orderedlist"><ol class="orderedlist" type="1">
@ -125,7 +125,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.new.for_each.complexity"></a><h6>
<a name="id761723"></a>
<a name="id719190"></a>
<a class="link" href="for_each.html#range.reference.algorithms.new.for_each.complexity">Complexity</a>
</h6>
<p>

View File

@ -27,7 +27,7 @@
<a name="range.reference.algorithms.new.insert"></a><a class="link" href="insert.html" title="insert">insert</a>
</h5></div></div></div>
<a name="range.reference.algorithms.new.insert.prototype"></a><h6>
<a name="id761826"></a>
<a name="id719294"></a>
<a class="link" href="insert.html#range.reference.algorithms.new.insert.prototype">Prototype</a>
</h6>
<p>
@ -44,7 +44,7 @@
<p>
</p>
<a name="range.reference.algorithms.new.insert.description"></a><h6>
<a name="id761996"></a>
<a name="id719463"></a>
<a class="link" href="insert.html#range.reference.algorithms.new.insert.description">Description</a>
</h6>
<p>
@ -54,14 +54,14 @@
<code class="computeroutput"><span class="identifier">target</span></code>.
</p>
<a name="range.reference.algorithms.new.insert.definition"></a><h6>
<a name="id762062"></a>
<a name="id719529"></a>
<a class="link" href="insert.html#range.reference.algorithms.new.insert.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">algorithm_ext</span><span class="special">/</span><span class="identifier">insert</span><span class="special">.</span><span class="identifier">hpp</span></code>
</p>
<a name="range.reference.algorithms.new.insert.requirements"></a><h6>
<a name="id762132"></a>
<a name="id719599"></a>
<a class="link" href="insert.html#range.reference.algorithms.new.insert.requirements">Requirements</a>
</h6>
<div class="orderedlist"><ol class="orderedlist" type="1">
@ -81,7 +81,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.new.insert.complexity"></a><h6>
<a name="id762230"></a>
<a name="id719698"></a>
<a class="link" href="insert.html#range.reference.algorithms.new.insert.complexity">Complexity</a>
</h6>
<p>

View File

@ -27,7 +27,7 @@
<a name="range.reference.algorithms.new.iota"></a><a class="link" href="iota.html" title="iota">iota</a>
</h5></div></div></div>
<a name="range.reference.algorithms.new.iota.prototype"></a><h6>
<a name="id762295"></a>
<a name="id719762"></a>
<a class="link" href="iota.html#range.reference.algorithms.new.iota.prototype">Prototype</a>
</h6>
<p>
@ -39,7 +39,7 @@
<p>
</p>
<a name="range.reference.algorithms.new.iota.description"></a><h6>
<a name="id762421"></a>
<a name="id719888"></a>
<a class="link" href="iota.html#range.reference.algorithms.new.iota.description">Description</a>
</h6>
<p>
@ -50,14 +50,14 @@
<span class="special">+</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">distance</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">it</span><span class="special">)</span></code>
</p>
<a name="range.reference.algorithms.new.iota.definition"></a><h6>
<a name="id762557"></a>
<a name="id720025"></a>
<a class="link" href="iota.html#range.reference.algorithms.new.iota.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">algorithm_ext</span><span class="special">/</span><span class="identifier">iota</span><span class="special">.</span><span class="identifier">hpp</span></code>
</p>
<a name="range.reference.algorithms.new.iota.requirements"></a><h6>
<a name="id762627"></a>
<a name="id720095"></a>
<a class="link" href="iota.html#range.reference.algorithms.new.iota.requirements">Requirements</a>
</h6>
<div class="orderedlist"><ol class="orderedlist" type="1">
@ -73,7 +73,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.new.iota.complexity"></a><h6>
<a name="id762707"></a>
<a name="id720174"></a>
<a class="link" href="iota.html#range.reference.algorithms.new.iota.complexity">Complexity</a>
</h6>
<p>

View File

@ -27,7 +27,7 @@
<a name="range.reference.algorithms.new.is_sorted"></a><a class="link" href="is_sorted.html" title="is_sorted">is_sorted</a>
</h5></div></div></div>
<a name="range.reference.algorithms.new.is_sorted.prototype"></a><h6>
<a name="id762782"></a>
<a name="id720249"></a>
<a class="link" href="is_sorted.html#range.reference.algorithms.new.is_sorted.prototype">Prototype</a>
</h6>
<p>
@ -42,7 +42,7 @@
<p>
</p>
<a name="range.reference.algorithms.new.is_sorted.description"></a><h6>
<a name="id762975"></a>
<a name="id720441"></a>
<a class="link" href="is_sorted.html#range.reference.algorithms.new.is_sorted.description">Description</a>
</h6>
<p>
@ -58,14 +58,14 @@
is <code class="computeroutput"><span class="keyword">true</span></code>.
</p>
<a name="range.reference.algorithms.new.is_sorted.definition"></a><h6>
<a name="id763163"></a>
<a name="id720630"></a>
<a class="link" href="is_sorted.html#range.reference.algorithms.new.is_sorted.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">algorithm_ext</span><span class="special">/</span><span class="identifier">is_sorted</span><span class="special">.</span><span class="identifier">hpp</span></code>
</p>
<a name="range.reference.algorithms.new.is_sorted.requirements"></a><h6>
<a name="id763233"></a>
<a name="id720701"></a>
<a class="link" href="is_sorted.html#range.reference.algorithms.new.is_sorted.requirements">Requirements</a>
</h6>
<div class="orderedlist"><ol class="orderedlist" type="1">
@ -85,7 +85,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.new.is_sorted.complexity"></a><h6>
<a name="id763342"></a>
<a name="id720809"></a>
<a class="link" href="is_sorted.html#range.reference.algorithms.new.is_sorted.complexity">Complexity</a>
</h6>
<p>

View File

@ -27,7 +27,7 @@
<a name="range.reference.algorithms.new.overwrite"></a><a class="link" href="overwrite.html" title="overwrite">overwrite</a>
</h5></div></div></div>
<a name="range.reference.algorithms.new.overwrite.prototype"></a><h6>
<a name="id763407"></a>
<a name="id720874"></a>
<a class="link" href="overwrite.html#range.reference.algorithms.new.overwrite.prototype">Prototype</a>
</h6>
<p>
@ -43,7 +43,7 @@
<p>
</p>
<a name="range.reference.algorithms.new.overwrite.description"></a><h6>
<a name="id763541"></a>
<a name="id721008"></a>
<a class="link" href="overwrite.html#range.reference.algorithms.new.overwrite.description">Description</a>
</h6>
<p>
@ -52,14 +52,14 @@
into the range <code class="computeroutput"><span class="identifier">to</span></code>.
</p>
<a name="range.reference.algorithms.new.overwrite.definition"></a><h6>
<a name="id763596"></a>
<a name="id721064"></a>
<a class="link" href="overwrite.html#range.reference.algorithms.new.overwrite.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">algorithm_ext</span><span class="special">/</span><span class="identifier">overwrite</span><span class="special">.</span><span class="identifier">hpp</span></code>
</p>
<a name="range.reference.algorithms.new.overwrite.requirements"></a><h6>
<a name="id763666"></a>
<a name="id721134"></a>
<a class="link" href="overwrite.html#range.reference.algorithms.new.overwrite.requirements">Requirements</a>
</h6>
<div class="orderedlist"><ol class="orderedlist" type="1">
@ -88,7 +88,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.new.overwrite.complexity"></a><h6>
<a name="id763844"></a>
<a name="id721311"></a>
<a class="link" href="overwrite.html#range.reference.algorithms.new.overwrite.complexity">Complexity</a>
</h6>
<p>

View File

@ -27,7 +27,7 @@
<a name="range.reference.algorithms.new.push_back"></a><a class="link" href="push_back.html" title="push_back">push_back</a>
</h5></div></div></div>
<a name="range.reference.algorithms.new.push_back.prototype"></a><h6>
<a name="id763909"></a>
<a name="id721376"></a>
<a class="link" href="push_back.html#range.reference.algorithms.new.push_back.prototype">Prototype</a>
</h6>
<p>
@ -43,7 +43,7 @@
<p>
</p>
<a name="range.reference.algorithms.new.push_back.description"></a><h6>
<a name="id764048"></a>
<a name="id721514"></a>
<a class="link" href="push_back.html#range.reference.algorithms.new.push_back.description">Description</a>
</h6>
<p>
@ -52,14 +52,14 @@
to the back of the container <code class="computeroutput"><span class="identifier">target</span></code>.
</p>
<a name="range.reference.algorithms.new.push_back.definition"></a><h6>
<a name="id764103"></a>
<a name="id721571"></a>
<a class="link" href="push_back.html#range.reference.algorithms.new.push_back.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">algorithm_ext</span><span class="special">/</span><span class="identifier">push_back</span><span class="special">.</span><span class="identifier">hpp</span></code>
</p>
<a name="range.reference.algorithms.new.push_back.requirements"></a><h6>
<a name="id764173"></a>
<a name="id721640"></a>
<a class="link" href="push_back.html#range.reference.algorithms.new.push_back.requirements">Requirements</a>
</h6>
<div class="orderedlist"><ol class="orderedlist" type="1">
@ -79,7 +79,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.new.push_back.complexity"></a><h6>
<a name="id764285"></a>
<a name="id721752"></a>
<a class="link" href="push_back.html#range.reference.algorithms.new.push_back.complexity">Complexity</a>
</h6>
<p>

View File

@ -27,7 +27,7 @@
<a name="range.reference.algorithms.new.push_front"></a><a class="link" href="push_front.html" title="push_front">push_front</a>
</h5></div></div></div>
<a name="range.reference.algorithms.new.push_front.prototype"></a><h6>
<a name="id764350"></a>
<a name="id721817"></a>
<a class="link" href="push_front.html#range.reference.algorithms.new.push_front.prototype">Prototype</a>
</h6>
<p>
@ -43,7 +43,7 @@
<p>
</p>
<a name="range.reference.algorithms.new.push_front.description"></a><h6>
<a name="id764488"></a>
<a name="id721956"></a>
<a class="link" href="push_front.html#range.reference.algorithms.new.push_front.description">Description</a>
</h6>
<p>
@ -52,14 +52,14 @@
to the front of the container <code class="computeroutput"><span class="identifier">target</span></code>.
</p>
<a name="range.reference.algorithms.new.push_front.definition"></a><h6>
<a name="id764543"></a>
<a name="id722010"></a>
<a class="link" href="push_front.html#range.reference.algorithms.new.push_front.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">algorithm_ext</span><span class="special">/</span><span class="identifier">push_front</span><span class="special">.</span><span class="identifier">hpp</span></code>
</p>
<a name="range.reference.algorithms.new.push_front.requirements"></a><h6>
<a name="id764613"></a>
<a name="id722080"></a>
<a class="link" href="push_front.html#range.reference.algorithms.new.push_front.requirements">Requirements</a>
</h6>
<div class="orderedlist"><ol class="orderedlist" type="1">
@ -79,7 +79,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.new.push_front.complexity"></a><h6>
<a name="id764725"></a>
<a name="id722192"></a>
<a class="link" href="push_front.html#range.reference.algorithms.new.push_front.complexity">Complexity</a>
</h6>
<p>

View File

@ -27,7 +27,7 @@
<a name="range.reference.algorithms.new.remove_erase"></a><a class="link" href="remove_erase.html" title="remove_erase">remove_erase</a>
</h5></div></div></div>
<a name="range.reference.algorithms.new.remove_erase.prototype"></a><h6>
<a name="id764790"></a>
<a name="id722257"></a>
<a class="link" href="remove_erase.html#range.reference.algorithms.new.remove_erase.prototype">Prototype</a>
</h6>
<p>
@ -40,7 +40,7 @@
<p>
</p>
<a name="range.reference.algorithms.new.remove_erase.description"></a><h6>
<a name="id764927"></a>
<a name="id722394"></a>
<a class="link" href="remove_erase.html#range.reference.algorithms.new.remove_erase.description">Description</a>
</h6>
<p>
@ -50,14 +50,14 @@
algorithm which merely rearranges elements.
</p>
<a name="range.reference.algorithms.new.remove_erase.definition"></a><h6>
<a name="id764983"></a>
<a name="id722450"></a>
<a class="link" href="remove_erase.html#range.reference.algorithms.new.remove_erase.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">algorithm_ext</span><span class="special">/</span><span class="identifier">erase</span><span class="special">.</span><span class="identifier">hpp</span></code>
</p>
<a name="range.reference.algorithms.new.remove_erase.requirements"></a><h6>
<a name="id765054"></a>
<a name="id722521"></a>
<a class="link" href="remove_erase.html#range.reference.algorithms.new.remove_erase.requirements">Requirements</a>
</h6>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
@ -65,7 +65,7 @@
erase of an iterator range.
</li></ol></div>
<a name="range.reference.algorithms.new.remove_erase.complexity"></a><h6>
<a name="id765099"></a>
<a name="id722566"></a>
<a class="link" href="remove_erase.html#range.reference.algorithms.new.remove_erase.complexity">Complexity</a>
</h6>
<p>

View File

@ -27,7 +27,7 @@
<a name="range.reference.algorithms.new.remove_erase_if"></a><a class="link" href="remove_erase_if.html" title="remove_erase_if">remove_erase_if</a>
</h5></div></div></div>
<a name="range.reference.algorithms.new.remove_erase_if.prototype"></a><h6>
<a name="id765164"></a>
<a name="id722632"></a>
<a class="link" href="remove_erase_if.html#range.reference.algorithms.new.remove_erase_if.prototype">Prototype</a>
</h6>
<p>
@ -40,7 +40,7 @@
<p>
</p>
<a name="range.reference.algorithms.new.remove_erase_if.description"></a><h6>
<a name="id765291"></a>
<a name="id722759"></a>
<a class="link" href="remove_erase_if.html#range.reference.algorithms.new.remove_erase_if.description">Description</a>
</h6>
<p>
@ -51,14 +51,14 @@
algorithm which merely rearranges elements.
</p>
<a name="range.reference.algorithms.new.remove_erase_if.definition"></a><h6>
<a name="id765372"></a>
<a name="id722839"></a>
<a class="link" href="remove_erase_if.html#range.reference.algorithms.new.remove_erase_if.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">algorithm_ext</span><span class="special">/</span><span class="identifier">erase</span><span class="special">.</span><span class="identifier">hpp</span></code>
</p>
<a name="range.reference.algorithms.new.remove_erase_if.requirements"></a><h6>
<a name="id765442"></a>
<a name="id722909"></a>
<a class="link" href="remove_erase_if.html#range.reference.algorithms.new.remove_erase_if.requirements">Requirements</a>
</h6>
<div class="orderedlist"><ol class="orderedlist" type="1">
@ -72,7 +72,7 @@
</li>
</ol></div>
<a name="range.reference.algorithms.new.remove_erase_if.complexity"></a><h6>
<a name="id765516"></a>
<a name="id722983"></a>
<a class="link" href="remove_erase_if.html#range.reference.algorithms.new.remove_erase_if.complexity">Complexity</a>
</h6>
<p>