[range] merge doc fixes (r81888, r81889) from trunk

[SVN r82138]
This commit is contained in:
Nathan Ridge
2012-12-21 08:44:32 +00:00
parent bda0d613c1
commit a417560f09
165 changed files with 2312 additions and 2240 deletions

View File

@ -22,16 +22,15 @@
<div class="spirit-nav">
<a accesskey="p" href="pop_heap.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../heap.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="sort_heap.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="section range_reference_algorithms_heap_make_heap">
<div class="titlepage"><div><div><h5 class="title">
<a name="range.reference.algorithms.heap.make_heap"></a><a class="link" href="make_heap.html" title="make_heap">make_heap</a>
</h5></div></div></div>
<a name="range.reference.algorithms.heap.make_heap.prototype"></a><h6>
<a name="id741272"></a>
<a class="link" href="make_heap.html#range.reference.algorithms.heap.make_heap.prototype">Prototype</a>
<h6>
<a name="range.reference.algorithms.heap.make_heap.h0"></a>
<span><a name="range.reference.algorithms.heap.make_heap.prototype"></a></span><a class="link" href="make_heap.html#range.reference.algorithms.heap.make_heap.prototype">Prototype</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">&gt;</span>
<span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">make_heap</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">);</span>
@ -47,9 +46,9 @@
</pre>
<p>
</p>
<a name="range.reference.algorithms.heap.make_heap.description"></a><h6>
<a name="id741648"></a>
<a class="link" href="make_heap.html#range.reference.algorithms.heap.make_heap.description">Description</a>
<h6>
<a name="range.reference.algorithms.heap.make_heap.h1"></a>
<span><a name="range.reference.algorithms.heap.make_heap.description"></a></span><a class="link" href="make_heap.html#range.reference.algorithms.heap.make_heap.description">Description</a>
</h6>
<p>
<code class="computeroutput"><span class="identifier">make_heap</span></code> turns <code class="computeroutput"><span class="identifier">rng</span></code> into a heap.
@ -59,16 +58,16 @@
by evaluating <code class="computeroutput"><span class="identifier">pred</span></code> in
the predicate versions.
</p>
<a name="range.reference.algorithms.heap.make_heap.definition"></a><h6>
<a name="id741722"></a>
<a class="link" href="make_heap.html#range.reference.algorithms.heap.make_heap.definition">Definition</a>
<h6>
<a name="range.reference.algorithms.heap.make_heap.h2"></a>
<span><a name="range.reference.algorithms.heap.make_heap.definition"></a></span><a class="link" href="make_heap.html#range.reference.algorithms.heap.make_heap.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</span><span class="special">/</span><span class="identifier">heap_algorithm</span><span class="special">.</span><span class="identifier">hpp</span></code>
</p>
<a name="range.reference.algorithms.heap.make_heap.requirements"></a><h6>
<a name="id741791"></a>
<a class="link" href="make_heap.html#range.reference.algorithms.heap.make_heap.requirements">Requirements</a>
<h6>
<a name="range.reference.algorithms.heap.make_heap.h3"></a>
<span><a name="range.reference.algorithms.heap.make_heap.requirements"></a></span><a class="link" href="make_heap.html#range.reference.algorithms.heap.make_heap.requirements">Requirements</a>
</h6>
<p>
<span class="bold"><strong>For the non-predicate versions:</strong></span>
@ -117,9 +116,9 @@
argument types.
</li>
</ul></div>
<a name="range.reference.algorithms.heap.make_heap.complexity"></a><h6>
<a name="id742039"></a>
<a class="link" href="make_heap.html#range.reference.algorithms.heap.make_heap.complexity">Complexity</a>
<h6>
<a name="range.reference.algorithms.heap.make_heap.h4"></a>
<span><a name="range.reference.algorithms.heap.make_heap.complexity"></a></span><a class="link" href="make_heap.html#range.reference.algorithms.heap.make_heap.complexity">Complexity</a>
</h6>
<p>
Linear. At most <code class="computeroutput"><span class="number">3</span> <span class="special">*</span>
@ -129,7 +128,8 @@
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2003 -2010 Thorsten Ottosen, Neil Groves<p>
<td align="right"><div class="copyright-footer">Copyright &#169; 2003-2010 Thorsten Ottosen,
Neil Groves<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>

View File

@ -22,16 +22,15 @@
<div class="spirit-nav">
<a accesskey="p" href="push_heap.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../heap.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="make_heap.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="section range_reference_algorithms_heap_pop_heap">
<div class="titlepage"><div><div><h5 class="title">
<a name="range.reference.algorithms.heap.pop_heap"></a><a class="link" href="pop_heap.html" title="pop_heap">pop_heap</a>
</h5></div></div></div>
<a name="range.reference.algorithms.heap.pop_heap.prototype"></a><h6>
<a name="id740266"></a>
<a class="link" href="pop_heap.html#range.reference.algorithms.heap.pop_heap.prototype">Prototype</a>
<h6>
<a name="range.reference.algorithms.heap.pop_heap.h0"></a>
<span><a name="range.reference.algorithms.heap.pop_heap.prototype"></a></span><a class="link" href="pop_heap.html#range.reference.algorithms.heap.pop_heap.prototype">Prototype</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">&gt;</span>
<span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">pop_heap</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">);</span>
@ -47,9 +46,9 @@
</pre>
<p>
</p>
<a name="range.reference.algorithms.heap.pop_heap.description"></a><h6>
<a name="id740642"></a>
<a class="link" href="pop_heap.html#range.reference.algorithms.heap.pop_heap.description">Description</a>
<h6>
<a name="range.reference.algorithms.heap.pop_heap.h1"></a>
<span><a name="range.reference.algorithms.heap.pop_heap.description"></a></span><a class="link" href="pop_heap.html#range.reference.algorithms.heap.pop_heap.description">Description</a>
</h6>
<p>
<code class="computeroutput"><span class="identifier">pop_heap</span></code> removes the
@ -61,16 +60,16 @@
by evaluating <code class="computeroutput"><span class="identifier">pred</span></code> in
the predicate versions.
</p>
<a name="range.reference.algorithms.heap.pop_heap.definition"></a><h6>
<a name="id740796"></a>
<a class="link" href="pop_heap.html#range.reference.algorithms.heap.pop_heap.definition">Definition</a>
<h6>
<a name="range.reference.algorithms.heap.pop_heap.h2"></a>
<span><a name="range.reference.algorithms.heap.pop_heap.definition"></a></span><a class="link" href="pop_heap.html#range.reference.algorithms.heap.pop_heap.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</span><span class="special">/</span><span class="identifier">heap_algorithm</span><span class="special">.</span><span class="identifier">hpp</span></code>
</p>
<a name="range.reference.algorithms.heap.pop_heap.requirements"></a><h6>
<a name="id740866"></a>
<a class="link" href="pop_heap.html#range.reference.algorithms.heap.pop_heap.requirements">Requirements</a>
<h6>
<a name="range.reference.algorithms.heap.pop_heap.h3"></a>
<span><a name="range.reference.algorithms.heap.pop_heap.requirements"></a></span><a class="link" href="pop_heap.html#range.reference.algorithms.heap.pop_heap.requirements">Requirements</a>
</h6>
<p>
<span class="bold"><strong>For the non-predicate versions:</strong></span>
@ -119,9 +118,9 @@
argument types.
</li>
</ul></div>
<a name="range.reference.algorithms.heap.pop_heap.precondition_"></a><h6>
<a name="id741114"></a>
<a class="link" href="pop_heap.html#range.reference.algorithms.heap.pop_heap.precondition_">Precondition:</a>
<h6>
<a name="range.reference.algorithms.heap.pop_heap.h4"></a>
<span><a name="range.reference.algorithms.heap.pop_heap.precondition_"></a></span><a class="link" href="pop_heap.html#range.reference.algorithms.heap.pop_heap.precondition_">Precondition:</a>
</h6>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
@ -131,9 +130,9 @@
<code class="computeroutput"><span class="identifier">rng</span></code> is a heap.
</li>
</ul></div>
<a name="range.reference.algorithms.heap.pop_heap.complexity"></a><h6>
<a name="id741189"></a>
<a class="link" href="pop_heap.html#range.reference.algorithms.heap.pop_heap.complexity">Complexity</a>
<h6>
<a name="range.reference.algorithms.heap.pop_heap.h5"></a>
<span><a name="range.reference.algorithms.heap.pop_heap.complexity"></a></span><a class="link" href="pop_heap.html#range.reference.algorithms.heap.pop_heap.complexity">Complexity</a>
</h6>
<p>
Logarithmic. At most <code class="computeroutput"><span class="number">2</span> <span class="special">*</span>
@ -143,7 +142,8 @@
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2003 -2010 Thorsten Ottosen, Neil Groves<p>
<td align="right"><div class="copyright-footer">Copyright &#169; 2003-2010 Thorsten Ottosen,
Neil Groves<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>

View File

@ -22,16 +22,15 @@
<div class="spirit-nav">
<a accesskey="p" href="../heap.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../heap.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="pop_heap.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="section range_reference_algorithms_heap_push_heap">
<div class="titlepage"><div><div><h5 class="title">
<a name="range.reference.algorithms.heap.push_heap"></a><a class="link" href="push_heap.html" title="push_heap">push_heap</a>
</h5></div></div></div>
<a name="range.reference.algorithms.heap.push_heap.prototype"></a><h6>
<a name="id739222"></a>
<a class="link" href="push_heap.html#range.reference.algorithms.heap.push_heap.prototype">Prototype</a>
<h6>
<a name="range.reference.algorithms.heap.push_heap.h0"></a>
<span><a name="range.reference.algorithms.heap.push_heap.prototype"></a></span><a class="link" href="push_heap.html#range.reference.algorithms.heap.push_heap.prototype">Prototype</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">&gt;</span>
<span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">push_heap</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">);</span>
@ -47,9 +46,9 @@
</pre>
<p>
</p>
<a name="range.reference.algorithms.heap.push_heap.description"></a><h6>
<a name="id739596"></a>
<a class="link" href="push_heap.html#range.reference.algorithms.heap.push_heap.description">Description</a>
<h6>
<a name="range.reference.algorithms.heap.push_heap.h1"></a>
<span><a name="range.reference.algorithms.heap.push_heap.description"></a></span><a class="link" href="push_heap.html#range.reference.algorithms.heap.push_heap.description">Description</a>
</h6>
<p>
<code class="computeroutput"><span class="identifier">push_heap</span></code> adds an element
@ -61,16 +60,16 @@
by evaluating <code class="computeroutput"><span class="identifier">pred</span></code> in
the predicate versions.
</p>
<a name="range.reference.algorithms.heap.push_heap.definition"></a><h6>
<a name="id739755"></a>
<a class="link" href="push_heap.html#range.reference.algorithms.heap.push_heap.definition">Definition</a>
<h6>
<a name="range.reference.algorithms.heap.push_heap.h2"></a>
<span><a name="range.reference.algorithms.heap.push_heap.definition"></a></span><a class="link" href="push_heap.html#range.reference.algorithms.heap.push_heap.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</span><span class="special">/</span><span class="identifier">heap_algorithm</span><span class="special">.</span><span class="identifier">hpp</span></code>
</p>
<a name="range.reference.algorithms.heap.push_heap.requirements"></a><h6>
<a name="id739825"></a>
<a class="link" href="push_heap.html#range.reference.algorithms.heap.push_heap.requirements">Requirements</a>
<h6>
<a name="range.reference.algorithms.heap.push_heap.h3"></a>
<span><a name="range.reference.algorithms.heap.push_heap.requirements"></a></span><a class="link" href="push_heap.html#range.reference.algorithms.heap.push_heap.requirements">Requirements</a>
</h6>
<p>
<span class="bold"><strong>For the non-predicate versions:</strong></span>
@ -119,9 +118,9 @@
argument types.
</li>
</ul></div>
<a name="range.reference.algorithms.heap.push_heap.precondition_"></a><h6>
<a name="id740073"></a>
<a class="link" href="push_heap.html#range.reference.algorithms.heap.push_heap.precondition_">Precondition:</a>
<h6>
<a name="range.reference.algorithms.heap.push_heap.h4"></a>
<span><a name="range.reference.algorithms.heap.push_heap.precondition_"></a></span><a class="link" href="push_heap.html#range.reference.algorithms.heap.push_heap.precondition_">Precondition:</a>
</h6>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
@ -131,9 +130,9 @@
<code class="computeroutput"><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">prior</span><span class="special">(</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)))</span></code> is a heap.
</li>
</ul></div>
<a name="range.reference.algorithms.heap.push_heap.complexity"></a><h6>
<a name="id740193"></a>
<a class="link" href="push_heap.html#range.reference.algorithms.heap.push_heap.complexity">Complexity</a>
<h6>
<a name="range.reference.algorithms.heap.push_heap.h5"></a>
<span><a name="range.reference.algorithms.heap.push_heap.complexity"></a></span><a class="link" href="push_heap.html#range.reference.algorithms.heap.push_heap.complexity">Complexity</a>
</h6>
<p>
Logarithmic. At most <code class="computeroutput"><span class="identifier">log</span><span class="special">(</span><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> comparisons.
@ -141,7 +140,8 @@
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2003 -2010 Thorsten Ottosen, Neil Groves<p>
<td align="right"><div class="copyright-footer">Copyright &#169; 2003-2010 Thorsten Ottosen,
Neil Groves<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>

View File

@ -22,16 +22,15 @@
<div class="spirit-nav">
<a accesskey="p" href="make_heap.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../heap.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../permutation.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="section range_reference_algorithms_heap_sort_heap">
<div class="titlepage"><div><div><h5 class="title">
<a name="range.reference.algorithms.heap.sort_heap"></a><a class="link" href="sort_heap.html" title="sort_heap">sort_heap</a>
</h5></div></div></div>
<a name="range.reference.algorithms.heap.sort_heap.prototype"></a><h6>
<a name="id742115"></a>
<a class="link" href="sort_heap.html#range.reference.algorithms.heap.sort_heap.prototype">Prototype</a>
<h6>
<a name="range.reference.algorithms.heap.sort_heap.h0"></a>
<span><a name="range.reference.algorithms.heap.sort_heap.prototype"></a></span><a class="link" href="sort_heap.html#range.reference.algorithms.heap.sort_heap.prototype">Prototype</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">&gt;</span>
<span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">sort_heap</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">);</span>
@ -47,9 +46,9 @@
</pre>
<p>
</p>
<a name="range.reference.algorithms.heap.sort_heap.description"></a><h6>
<a name="id742491"></a>
<a class="link" href="sort_heap.html#range.reference.algorithms.heap.sort_heap.description">Description</a>
<h6>
<a name="range.reference.algorithms.heap.sort_heap.h1"></a>
<span><a name="range.reference.algorithms.heap.sort_heap.description"></a></span><a class="link" href="sort_heap.html#range.reference.algorithms.heap.sort_heap.description">Description</a>
</h6>
<p>
<code class="computeroutput"><span class="identifier">sort_heap</span></code> turns a heap
@ -60,16 +59,16 @@
by evaluating <code class="computeroutput"><span class="identifier">pred</span></code> in
the predicate versions.
</p>
<a name="range.reference.algorithms.heap.sort_heap.definition"></a><h6>
<a name="id742555"></a>
<a class="link" href="sort_heap.html#range.reference.algorithms.heap.sort_heap.definition">Definition</a>
<h6>
<a name="range.reference.algorithms.heap.sort_heap.h2"></a>
<span><a name="range.reference.algorithms.heap.sort_heap.definition"></a></span><a class="link" href="sort_heap.html#range.reference.algorithms.heap.sort_heap.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</span><span class="special">/</span><span class="identifier">heap_algorithm</span><span class="special">.</span><span class="identifier">hpp</span></code>
</p>
<a name="range.reference.algorithms.heap.sort_heap.requirements"></a><h6>
<a name="id742626"></a>
<a class="link" href="sort_heap.html#range.reference.algorithms.heap.sort_heap.requirements">Requirements</a>
<h6>
<a name="range.reference.algorithms.heap.sort_heap.h3"></a>
<span><a name="range.reference.algorithms.heap.sort_heap.requirements"></a></span><a class="link" href="sort_heap.html#range.reference.algorithms.heap.sort_heap.requirements">Requirements</a>
</h6>
<p>
<span class="bold"><strong>For the non-predicate versions:</strong></span>
@ -118,16 +117,16 @@
argument types.
</li>
</ul></div>
<a name="range.reference.algorithms.heap.sort_heap.precondition_"></a><h6>
<a name="id742873"></a>
<a class="link" href="sort_heap.html#range.reference.algorithms.heap.sort_heap.precondition_">Precondition:</a>
<h6>
<a name="range.reference.algorithms.heap.sort_heap.h4"></a>
<span><a name="range.reference.algorithms.heap.sort_heap.precondition_"></a></span><a class="link" href="sort_heap.html#range.reference.algorithms.heap.sort_heap.precondition_">Precondition:</a>
</h6>
<p>
<code class="computeroutput"><span class="identifier">rng</span></code> is a heap.
</p>
<a name="range.reference.algorithms.heap.sort_heap.complexity"></a><h6>
<a name="id742906"></a>
<a class="link" href="sort_heap.html#range.reference.algorithms.heap.sort_heap.complexity">Complexity</a>
<h6>
<a name="range.reference.algorithms.heap.sort_heap.h5"></a>
<span><a name="range.reference.algorithms.heap.sort_heap.complexity"></a></span><a class="link" href="sort_heap.html#range.reference.algorithms.heap.sort_heap.complexity">Complexity</a>
</h6>
<p>
At most <code class="computeroutput"><span class="identifier">N</span> <span class="special">*</span>
@ -138,7 +137,8 @@
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2003 -2010 Thorsten Ottosen, Neil Groves<p>
<td align="right"><div class="copyright-footer">Copyright &#169; 2003-2010 Thorsten Ottosen,
Neil Groves<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>