<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../index.html" title="The Boost Algorithm Library">
<link rel="up" href="../index.html" title="The Boost Algorithm Library">
-<link rel="prev" href="../the_boost_algorithm_library/CXX11/partition_point.html" title="partition_point">
-<link rel="next" href="../the_boost_algorithm_library/CXX14/mismatch.html" title="mismatch">
+<link rel="prev" href="CXX11.html" title="C++11 Algorithms">
+<link rel="next" href="CXX17.html" title="C++17 Algorithms">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="
../the_boost_algorithm_library/CXX11/partition_point.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="../the_boost_algorithm_library/CXX14/mismatch.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="
CXX11.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="CXX17.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="algorithm.CXX14"></a><a class="link" href="CXX14.html" title="C++14 Algorithms">C++14 Algorithms</a>
</h2></div></div></div>
<div class="toc"><dl class="toc">
-<dt><span class="section"><a href="CXX14.html#the_boost_algorithm_library.CXX14.equal">equal </a></span></dt>
-<dt><span class="section"><a href="../the_boost_algorithm_library/CXX14/mismatch.html">mismatch
- </a></span></dt>
+<dt><span class="section"><a href="CXX14.html#algorithm.CXX14.CXX14_inner_algorithms"></a></span></dt>
+<dd><dl>
+<dt><span class="section"><a href="CXX14.html#the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal">equal
+ </a></span></dt>
+<dt><span class="section"><a href="CXX14.html#the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch">mismatch
+ </a></span></dt>
+</dl></dd>
</dl></div>
<div class="section">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="the_boost_algorithm_library.CXX14.equal"></a><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.equal" title="equal">equal </a>
-</h3></div></div></div>
+<div class="titlepage"></div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal"></a><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal" title="equal">equal
+ </a>
+</h4></div></div></div>
<p>
- The header file 'equal.hpp' contains two variants of a the stl algorithm
- <code class="computeroutput"><span class="identifier">equal</span></code>. The algorithm tests
- to see if two sequences contain equal values;
- </p>
+ The header file 'equal.hpp' contains two variants of a the stl algorithm
+ <code class="computeroutput"><span class="identifier">equal</span></code>. The algorithm tests
+ to see if two sequences contain equal values;
+ </p>
<p>
- Before (the proposed) C++14 the algorithm <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">equal</span></code>
- took three iterators and an optional comparison predicate. The first two
- iterators <code class="computeroutput"><span class="special">[</span><span class="identifier">first1</span><span class="special">,</span> <span class="identifier">last1</span><span class="special">)</span></code> defined a sequence, and the second one
- <code class="computeroutput"><span class="identifier">first2</span></code> defined the start
- of the second sequence. The second sequence was assumed to be the same length
- as the first.
- </p>
+ Before (the proposed) C++14 the algorithm <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">equal</span></code>
+ took three iterators and an optional comparison predicate. The first two
+ iterators <code class="computeroutput"><span class="special">[</span><span class="identifier">first1</span><span class="special">,</span> <span class="identifier">last1</span><span class="special">)</span></code> defined a sequence, and the second one
+ <code class="computeroutput"><span class="identifier">first2</span></code> defined the start
+ of the second sequence. The second sequence was assumed to be the same
+ length as the first.
+ </p>
<p>
- In C++14, two new variants were introduced, taking four iterators and an
- optional comparison predicate. The four iterators define two sequences <code class="computeroutput"><span class="special">[</span><span class="identifier">first1</span><span class="special">,</span> <span class="identifier">last1</span><span class="special">)</span></code> and <code class="computeroutput"><span class="special">[</span><span class="identifier">first2</span><span class="special">,</span> <span class="identifier">last2</span><span class="special">)</span></code>
- explicitly, rather than defining the second one implicitly. This leads to
- correct answers in more cases (and avoid undefined behavior in others).
- </p>
+ In C++14, two new variants were introduced, taking four iterators and an
+ optional comparison predicate. The four iterators define two sequences
+ <code class="computeroutput"><span class="special">[</span><span class="identifier">first1</span><span class="special">,</span> <span class="identifier">last1</span><span class="special">)</span></code> and <code class="computeroutput"><span class="special">[</span><span class="identifier">first2</span><span class="special">,</span> <span class="identifier">last2</span><span class="special">)</span></code>
+ explicitly, rather than defining the second one implicitly. This leads
+ to correct answers in more cases (and avoid undefined behavior in others).
+ </p>
<p>
- Consider the two sequences:
+ Consider the two sequences:
</p>
<pre class="programlisting"><span class="keyword">auto</span> <span class="identifier">seq1</span> <span class="special">=</span> <span class="special">{</span> <span class="number">0</span><span class="special">,</span> <span class="number">1</span><span class="special">,</span> <span class="number">2</span> <span class="special">};</span>
<span class="keyword">auto</span> <span class="identifier">seq2</span> <span class="special">=</span> <span class="special">{</span> <span class="number">0</span><span class="special">,</span> <span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">,</span> <span class="number">4</span> <span class="special">};</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">equal</span> <span class="special">(</span> <span class="identifier">seq1</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">seq1</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">seq2</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">seq2</span><span class="special">.</span><span class="identifier">end</span> <span class="special">());</span> <span class="comment">// false</span>
</pre>
<p>
- </p>
+ </p>
<p>
- You can argue that <code class="computeroutput"><span class="keyword">true</span></code> is the
- correct answer in the first case, even though the sequences are not the same.
- The first N entries in <code class="computeroutput"><span class="identifier">seq2</span></code>
- are the same as the entries in <code class="computeroutput"><span class="identifier">seq1</span></code>
- - but that's not all that's in <code class="computeroutput"><span class="identifier">seq2</span></code>.
- But in the second case, the algorithm will read past the end of <code class="computeroutput"><span class="identifier">seq1</span></code>, resulting in undefined behavior (large
- earthquake, incorrect results, pregnant cat, etc).
- </p>
+ You can argue that <code class="computeroutput"><span class="keyword">true</span></code> is
+ the correct answer in the first case, even though the sequences are not
+ the same. The first N entries in <code class="computeroutput"><span class="identifier">seq2</span></code>
+ are the same as the entries in <code class="computeroutput"><span class="identifier">seq1</span></code>
+ - but that's not all that's in <code class="computeroutput"><span class="identifier">seq2</span></code>.
+ But in the second case, the algorithm will read past the end of <code class="computeroutput"><span class="identifier">seq1</span></code>, resulting in undefined behavior
+ (large earthquake, incorrect results, pregnant cat, etc).
+ </p>
<p>
- However, if the two sequences are specified completely, it's clear that they
- are not equal.
- </p>
-<h5>
-<a name="the_boost_algorithm_library.CXX14.equal.h0"></a>
- <span class="phrase"><a name="the_boost_algorithm_library.CXX14.equal.interface"></a></span><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.equal.interface">interface</a>
- </h5>
-<p>
- The function <code class="computeroutput"><span class="identifier">equal</span></code> returns
- true if the two sequences compare equal; i.e, if each element in the sequence
- compares equal to the corresponding element in the other sequence. One version
- uses <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">equal_to</span></code> to do the comparison; the other
- lets the caller pass predicate to do the comparisons.
- </p>
+ However, if the two sequences are specified completely, it's clear that
+ they are not equal.
+ </p>
+<h6>
+<a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal.h0"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal.interface"></a></span><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal.interface">interface</a>
+ </h6>
+<p>
+ The function <code class="computeroutput"><span class="identifier">equal</span></code> returns
+ true if the two sequences compare equal; i.e, if each element in the sequence
+ compares equal to the corresponding element in the other sequence. One
+ version uses <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">equal_to</span></code> to do the comparison; the other
+ lets the caller pass predicate to do the comparisons.
+ </p>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">InputIterator1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">InputIterator2</span><span class="special">></span>
<span class="identifier">InputIterator2</span> <span class="identifier">first2</span><span class="special">,</span> <span class="identifier">InputIterator2</span> <span class="identifier">last2</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span> <span class="special">);</span>
</pre>
<p>
- </p>
-<h5>
-<a name="the_boost_algorithm_library.CXX14.equal.h1"></a>
- <span class="phrase"><a name="the_boost_algorithm_library.CXX14.equal.examples"></a></span><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.equal.examples">Examples</a>
- </h5>
-<p>
- Given the container <code class="computeroutput"><span class="identifier">c1</span></code> containing
- <code class="computeroutput"><span class="special">{</span> <span class="number">0</span><span class="special">,</span> <span class="number">1</span><span class="special">,</span>
- <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">,</span> <span class="number">14</span><span class="special">,</span> <span class="number">15</span> <span class="special">}</span></code>,
- and <code class="computeroutput"><span class="identifier">c2</span></code> containing <code class="computeroutput"><span class="special">{</span> <span class="number">1</span><span class="special">,</span>
- <span class="number">2</span><span class="special">,</span> <span class="number">3</span> <span class="special">}</span></code>, then
+ </p>
+<h6>
+<a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal.h1"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal.examples"></a></span><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal.examples">Examples</a>
+ </h6>
+<p>
+ Given the container <code class="computeroutput"><span class="identifier">c1</span></code>
+ containing <code class="computeroutput"><span class="special">{</span> <span class="number">0</span><span class="special">,</span> <span class="number">1</span><span class="special">,</span>
+ <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">,</span> <span class="number">14</span><span class="special">,</span> <span class="number">15</span> <span class="special">}</span></code>,
+ and <code class="computeroutput"><span class="identifier">c2</span></code> containing <code class="computeroutput"><span class="special">{</span> <span class="number">1</span><span class="special">,</span>
+ <span class="number">2</span><span class="special">,</span> <span class="number">3</span> <span class="special">}</span></code>, then
</p>
<pre class="programlisting"><span class="identifier">equal</span> <span class="special">(</span> <span class="identifier">c1</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">c1</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">c2</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">c2</span><span class="special">.</span><span class="identifier">end</span> <span class="special">())</span> <span class="special">--></span> <span class="keyword">false</span>
<span class="identifier">equal</span> <span class="special">(</span> <span class="identifier">c1</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">()</span> <span class="special">+</span> <span class="number">1</span><span class="special">,</span> <span class="identifier">c1</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">()</span> <span class="special">+</span> <span class="number">3</span><span class="special">,</span> <span class="identifier">c2</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">c2</span><span class="special">.</span><span class="identifier">end</span> <span class="special">())</span> <span class="special">--></span> <span class="keyword">true</span>
<span class="identifier">equal</span> <span class="special">(</span> <span class="identifier">c1</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">c1</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">c2</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">c2</span><span class="special">.</span><span class="identifier">end</span> <span class="special">())</span> <span class="special">--></span> <span class="keyword">true</span> <span class="comment">// empty sequences are alway equal to each other</span>
</pre>
<p>
- </p>
-<h5>
-<a name="the_boost_algorithm_library.CXX14.equal.h2"></a>
- <span class="phrase"><a name="the_boost_algorithm_library.CXX14.equal.iterator_requirements"></a></span><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.equal.iterator_requirements">Iterator
- Requirements</a>
- </h5>
-<p>
- <code class="computeroutput"><span class="identifier">equal</span></code> works on all iterators
- except output iterators.
- </p>
-<h5>
-<a name="the_boost_algorithm_library.CXX14.equal.h3"></a>
- <span class="phrase"><a name="the_boost_algorithm_library.CXX14.equal.complexity"></a></span><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.equal.complexity">Complexity</a>
- </h5>
-<p>
- Both of the variants of <code class="computeroutput"><span class="identifier">equal</span></code>
- run in <span class="emphasis"><em>O(N)</em></span> (linear) time; that is, they compare against
- each element in the list once. If the sequence is found to be not equal at
- any point, the routine will terminate immediately, without examining the
- rest of the elements.
- </p>
-<h5>
-<a name="the_boost_algorithm_library.CXX14.equal.h4"></a>
- <span class="phrase"><a name="the_boost_algorithm_library.CXX14.equal.exception_safety"></a></span><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.equal.exception_safety">Exception
- Safety</a>
- </h5>
-<p>
- Both of the variants of <code class="computeroutput"><span class="identifier">equal</span></code>
- take their parameters by value and do not depend upon any global state. Therefore,
- all the routines in this file provide the strong exception guarantee.
- </p>
-<h5>
-<a name="the_boost_algorithm_library.CXX14.equal.h5"></a>
- <span class="phrase"><a name="the_boost_algorithm_library.CXX14.equal.notes"></a></span><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.equal.notes">Notes</a>
- </h5>
+ </p>
+<h6>
+<a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal.h2"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal.iterator_requirements"></a></span><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal.iterator_requirements">Iterator
+ Requirements</a>
+ </h6>
+<p>
+ <code class="computeroutput"><span class="identifier">equal</span></code> works on all iterators
+ except output iterators.
+ </p>
+<h6>
+<a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal.h3"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal.complexity"></a></span><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal.complexity">Complexity</a>
+ </h6>
+<p>
+ Both of the variants of <code class="computeroutput"><span class="identifier">equal</span></code>
+ run in <span class="emphasis"><em>O(N)</em></span> (linear) time; that is, they compare against
+ each element in the list once. If the sequence is found to be not equal
+ at any point, the routine will terminate immediately, without examining
+ the rest of the elements.
+ </p>
+<h6>
+<a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal.h4"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal.exception_safety"></a></span><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal.exception_safety">Exception
+ Safety</a>
+ </h6>
+<p>
+ Both of the variants of <code class="computeroutput"><span class="identifier">equal</span></code>
+ take their parameters by value and do not depend upon any global state.
+ Therefore, all the routines in this file provide the strong exception guarantee.
+ </p>
+<h6>
+<a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal.h5"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal.notes"></a></span><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.equal.notes">Notes</a>
+ </h6>
+<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+<li class="listitem">
+ The four iterator version of the routine <code class="computeroutput"><span class="identifier">equal</span></code>
+ is part of the C++14 standard. When C++14 standard library implementations
+ become available, the implementation from the standard library should
+ be used.
+ </li>
+<li class="listitem">
+ <code class="computeroutput"><span class="identifier">equal</span></code> returns true
+ for two empty ranges, no matter what predicate is passed to test against.
+ </li>
+</ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch"></a><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch" title="mismatch">mismatch
+ </a>
+</h4></div></div></div>
+<p>
+ The header file 'mismatch.hpp' contains two variants of a the stl algorithm
+ <code class="computeroutput"><span class="identifier">mismatch</span></code>. The algorithm
+ finds the first point in two sequences where they do not match.
+ </p>
+<p>
+ Before (the proposed) C++14 the algorithm <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">mismatch</span></code>
+ took three iterators and an optional comparison predicate. The first two
+ iterators <code class="computeroutput"><span class="special">[</span><span class="identifier">first1</span><span class="special">,</span> <span class="identifier">last1</span><span class="special">)</span></code> defined a sequence, and the second one
+ <code class="computeroutput"><span class="identifier">first2</span></code> defined the start
+ of the second sequence. The second sequence was assumed to be the same
+ length as the first.
+ </p>
+<p>
+ In C++14, two new variants were introduced, taking four iterators and an
+ optional comparison predicate. The four iterators define two sequences
+ <code class="computeroutput"><span class="special">[</span><span class="identifier">first1</span><span class="special">,</span> <span class="identifier">last1</span><span class="special">)</span></code> and <code class="computeroutput"><span class="special">[</span><span class="identifier">first2</span><span class="special">,</span> <span class="identifier">last2</span><span class="special">)</span></code>
+ explicitly, rather than defining the second one implicitly. This leads
+ to correct answers in more cases (and avoid undefined behavior in others).
+ </p>
+<p>
+ Consider the two sequences:
+</p>
+<pre class="programlisting"><span class="keyword">auto</span> <span class="identifier">seq1</span> <span class="special">=</span> <span class="special">{</span> <span class="number">0</span><span class="special">,</span> <span class="number">1</span><span class="special">,</span> <span class="number">2</span> <span class="special">};</span>
+<span class="keyword">auto</span> <span class="identifier">seq2</span> <span class="special">=</span> <span class="special">{</span> <span class="number">0</span><span class="special">,</span> <span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">,</span> <span class="number">4</span> <span class="special">};</span>
+
+<span class="identifier">std</span><span class="special">::</span><span class="identifier">mismatch</span> <span class="special">(</span> <span class="identifier">seq1</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">seq1</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">seq2</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">());</span> <span class="comment">// <3, 3></span>
+<span class="identifier">std</span><span class="special">::</span><span class="identifier">mismatch</span> <span class="special">(</span> <span class="identifier">seq2</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">seq2</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">seq1</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">());</span> <span class="comment">// Undefined behavior</span>
+<span class="identifier">std</span><span class="special">::</span><span class="identifier">mismatch</span> <span class="special">(</span> <span class="identifier">seq1</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">seq1</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">seq2</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">seq2</span><span class="special">.</span><span class="identifier">end</span> <span class="special">());</span> <span class="comment">// <3, 3></span>
+</pre>
+<p>
+ </p>
+<p>
+ The first N entries in <code class="computeroutput"><span class="identifier">seq2</span></code>
+ are the same as the entries in <code class="computeroutput"><span class="identifier">seq1</span></code>
+ - but that's not all that's in <code class="computeroutput"><span class="identifier">seq2</span></code>.
+ In the second case, the algorithm will read past the end of <code class="computeroutput"><span class="identifier">seq1</span></code>, resulting in undefined behavior
+ (large earthquake, incorrect results, pregnant cat, etc).
+ </p>
+<p>
+ However, if the two sequences are specified completely, it's clear that
+ where the mismatch occurs.
+ </p>
+<h6>
+<a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch.h0"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch.interface"></a></span><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch.interface">interface</a>
+ </h6>
+<p>
+ The function <code class="computeroutput"><span class="identifier">mismatch</span></code> returns
+ a pair of iterators which denote the first mismatching elements in each
+ sequence. If the sequences match completely, <code class="computeroutput"><span class="identifier">mismatch</span></code>
+ returns their end iterators. One version uses <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">equal_to</span></code>
+ to do the comparison; the other lets the caller pass predicate to do the
+ comparisons.
+ </p>
+<p>
+</p>
+<pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">InputIterator1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">InputIterator2</span><span class="special">></span>
+<span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">InputIterator1</span><span class="special">,</span> <span class="identifier">InputIterator2</span><span class="special">></span>
+<span class="identifier">mismatch</span> <span class="special">(</span> <span class="identifier">InputIterator1</span> <span class="identifier">first1</span><span class="special">,</span> <span class="identifier">InputIterator1</span> <span class="identifier">last1</span><span class="special">,</span>
+ <span class="identifier">InputIterator2</span> <span class="identifier">first2</span><span class="special">,</span> <span class="identifier">InputIterator2</span> <span class="identifier">last2</span> <span class="special">);</span>
+
+<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">InputIterator1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">InputIterator2</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">></span>
+<span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">InputIterator1</span><span class="special">,</span> <span class="identifier">InputIterator2</span><span class="special">></span>
+<span class="identifier">mismatch</span> <span class="special">(</span> <span class="identifier">InputIterator1</span> <span class="identifier">first1</span><span class="special">,</span> <span class="identifier">InputIterator1</span> <span class="identifier">last1</span><span class="special">,</span>
+ <span class="identifier">InputIterator2</span> <span class="identifier">first2</span><span class="special">,</span> <span class="identifier">InputIterator2</span> <span class="identifier">last2</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span> <span class="special">);</span>
+</pre>
+<p>
+ </p>
+<h6>
+<a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch.h1"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch.examples"></a></span><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch.examples">Examples</a>
+ </h6>
+<p>
+ Given the container <code class="computeroutput"><span class="identifier">c1</span></code>
+ containing <code class="computeroutput"><span class="special">{</span> <span class="number">0</span><span class="special">,</span> <span class="number">1</span><span class="special">,</span>
+ <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">,</span> <span class="number">14</span><span class="special">,</span> <span class="number">15</span> <span class="special">}</span></code>,
+ and <code class="computeroutput"><span class="identifier">c2</span></code> containing <code class="computeroutput"><span class="special">{</span> <span class="number">1</span><span class="special">,</span>
+ <span class="number">2</span><span class="special">,</span> <span class="number">3</span> <span class="special">}</span></code>, then
+</p>
+<pre class="programlisting"><span class="identifier">mismatch</span> <span class="special">(</span> <span class="identifier">c1</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">c1</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span> <span class="identifier">c2</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">c2</span><span class="special">.</span><span class="identifier">end</span><span class="special">())</span> <span class="special">--></span> <span class="special"><</span><span class="identifier">c1</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">c2</span><span class="special">.</span><span class="identifier">begin</span><span class="special">()></span> <span class="comment">// first elements do not match</span>
+<span class="identifier">mismatch</span> <span class="special">(</span> <span class="identifier">c1</span><span class="special">.</span><span class="identifier">begin</span><span class="special">()</span> <span class="special">+</span> <span class="number">1</span><span class="special">,</span> <span class="identifier">c1</span><span class="special">.</span><span class="identifier">begin</span><span class="special">()</span> <span class="special">+</span> <span class="number">4</span><span class="special">,</span> <span class="identifier">c2</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">c2</span><span class="special">.</span><span class="identifier">end</span><span class="special">())</span> <span class="special">--></span> <span class="special"><</span><span class="identifier">c1</span><span class="special">.</span><span class="identifier">begin</span><span class="special">()</span> <span class="special">+</span> <span class="number">4</span><span class="special">,</span> <span class="identifier">c2</span><span class="special">.</span><span class="identifier">end</span> <span class="special">()></span> <span class="comment">// all elements of `c2` match</span>
+<span class="identifier">mismatch</span> <span class="special">(</span> <span class="identifier">c1</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span> <span class="identifier">c1</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span> <span class="identifier">c2</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span> <span class="identifier">c2</span><span class="special">.</span><span class="identifier">end</span><span class="special">())</span> <span class="special">--></span> <span class="special"><</span><span class="identifier">c1</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span> <span class="identifier">c2</span><span class="special">.</span><span class="identifier">end</span><span class="special">()></span> <span class="comment">// empty sequences don't match at the end.</span>
+</pre>
+<p>
+ </p>
+<h6>
+<a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch.h2"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch.iterator_requirements"></a></span><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch.iterator_requirements">Iterator
+ Requirements</a>
+ </h6>
+<p>
+ <code class="computeroutput"><span class="identifier">mismatch</span></code> works on all iterators
+ except output iterators.
+ </p>
+<h6>
+<a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch.h3"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch.complexity"></a></span><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch.complexity">Complexity</a>
+ </h6>
+<p>
+ Both of the variants of <code class="computeroutput"><span class="identifier">mismatch</span></code>
+ run in <span class="emphasis"><em>O(N)</em></span> (linear) time; that is, they compare against
+ each element in the list once. If the sequence is found to be not equal
+ at any point, the routine will terminate immediately, without examining
+ the rest of the elements.
+ </p>
+<h6>
+<a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch.h4"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch.exception_safety"></a></span><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch.exception_safety">Exception
+ Safety</a>
+ </h6>
+<p>
+ Both of the variants of <code class="computeroutput"><span class="identifier">mismatch</span></code>
+ take their parameters by value and do not depend upon any global state.
+ Therefore, all the routines in this file provide the strong exception guarantee.
+ </p>
+<h6>
+<a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch.h5"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch.notes"></a></span><a class="link" href="CXX14.html#the_boost_algorithm_library.CXX14.CXX14_inner_algorithms.mismatch.notes">Notes</a>
+ </h6>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
- The four iterator version of the routine <code class="computeroutput"><span class="identifier">equal</span></code>
- is part of the C++14 standard. When C++14 standard library implementations
- become available, the implementation from the standard library should
- be used.
- </li>
+ If the sequences are equal (or both are empty), then mismatch returns
+ the end iterators of both sequences.
+ </li>
<li class="listitem">
- <code class="computeroutput"><span class="identifier">equal</span></code> returns true for
- two empty ranges, no matter what predicate is passed to test against.
- </li>
+ The four iterator version of the routine <code class="computeroutput"><span class="identifier">mismatch</span></code>
+ is part of the C++14 standard. When C++14 standard library implementations
+ become available, the implementation from the standard library should
+ be used.
+ </li>
</ul></div>
</div>
</div>
+</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 © 2010-2012 Marshall Clow<p>
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="
../the_boost_algorithm_library/CXX11/partition_point.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="../the_boost_algorithm_library/CXX14/mismatch.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="
CXX11.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="CXX17.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
projects / platform / upstream / boost.git / blobdiff