Boost.Range commit fix for the mismatch documentation - thanks to vincente botet for spotting this.

[SVN r61651]
This commit is contained in:
Neil Groves 2010-04-28 16:52:24 +00:00
parent ec58d739eb
commit 5364ea2cad
2 changed files with 9 additions and 17 deletions

View File

@ -28,7 +28,7 @@
mismatch</a>
</h5></div></div></div>
<a name="range.reference.algorithms.non_mutating.mismatch.prototype"></a><h6>
<a name="id2802051"></a>
<a name="id3236364"></a>
<a class="link" href="mismatch.html#range.reference.algorithms.non_mutating.mismatch.prototype">Prototype</a>
</h6>
<p>
@ -106,32 +106,26 @@
<p>
</p>
<a name="range.reference.algorithms.non_mutating.mismatch.description"></a><h6>
<a name="id2803769"></a>
<a name="id3238082"></a>
<a class="link" href="mismatch.html#range.reference.algorithms.non_mutating.mismatch.description">Description</a>
</h6>
<p>
<code class="computeroutput"><span class="identifier">mismatch</span></code> finds the first
position where the two ranges <code class="computeroutput"><span class="identifier">rng1</span></code>
and <code class="computeroutput"><span class="identifier">rng2</span></code> differ.
position where the correseponding elements from the two ranges <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code>
are not equal.
</p>
<p>
Equality is determined by <code class="computeroutput"><span class="keyword">operator</span><span class="special">==</span></code> for non-predicate versions of <code class="computeroutput"><span class="identifier">mismatch</span></code>, and by satisfying <code class="computeroutput"><span class="identifier">pred</span></code> in the predicate versions.
</p>
<p>
The versions of <code class="computeroutput"><span class="identifier">mismatch</span></code>
that return a <code class="computeroutput"><span class="identifier">range_return</span></code>,
defines <code class="computeroutput"><span class="identifier">found</span></code> in the
same manner as the returned iterator described above.
</p>
<a name="range.reference.algorithms.non_mutating.mismatch.definition"></a><h6>
<a name="id2803909"></a>
<a name="id3238184"></a>
<a class="link" href="mismatch.html#range.reference.algorithms.non_mutating.mismatch.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">mismatch</span><span class="special">.</span><span class="identifier">hpp</span></code>
</p>
<a name="range.reference.algorithms.non_mutating.mismatch.requirements"></a><h6>
<a name="id2803982"></a>
<a name="id3238257"></a>
<a class="link" href="mismatch.html#range.reference.algorithms.non_mutating.mismatch.requirements">Requirements</a>
</h6>
<p>
@ -192,14 +186,14 @@
</li>
</ul></div>
<a name="range.reference.algorithms.non_mutating.mismatch.precondition_"></a><h6>
<a name="id2804278"></a>
<a name="id3238554"></a>
<a class="link" href="mismatch.html#range.reference.algorithms.non_mutating.mismatch.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>
</p>
<a name="range.reference.algorithms.non_mutating.mismatch.complexity"></a><h6>
<a name="id2804354"></a>
<a name="id3238629"></a>
<a class="link" href="mismatch.html#range.reference.algorithms.non_mutating.mismatch.complexity">Complexity</a>
</h6>
<p>

View File

@ -75,12 +75,10 @@ mismatch(const SinglePassRange1& rng1, SinglePassRange2& rng2,
[heading Description]
`mismatch` finds the first position where the two ranges `rng1` and `rng2` differ.
`mismatch` finds the first position where the correseponding elements from the two ranges `rng1` and `rng2` are not equal.
Equality is determined by `operator==` for non-predicate versions of `mismatch`, and by satisfying `pred` in the predicate versions.
The versions of `mismatch` that return a `range_return`, defines `found` in the same manner as the returned iterator described above.
[heading Definition]
Defined in the header file `boost/range/algorithm/mismatch.hpp`