libs/range/doc/html/range/reference/algorithms/non_mutating/mismatch.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>mismatch</title>
   5 <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Range 2.0">
   8 <link rel="up" href="../non_mutating.html" title="Non-mutating algorithms">
   9 <link rel="prev" href="min_element.html" title="min_element">
  10 <link rel="next" href="search.html" title="search">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="min_element.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.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="search.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="range.reference.algorithms.non_mutating.mismatch"></a><a class="link" href="mismatch.html" title="mismatch">mismatch</a>
  28 </h5></div></div></div>
  29 <a name="range.reference.algorithms.non_mutating.mismatch.prototype"></a><h6>
  30 <a name="id726777"></a>
  31             <a class="link" href="mismatch.html#range.reference.algorithms.non_mutating.mismatch.prototype">Prototype</a>
  32           </h6>
  33 <p>
  34
  35 </p>
  36 <pre class="programlisting"><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">&gt;</span>
  37 <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span>
  38     <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="identifier">SinglePassRange1</span><span class="special">&gt;::</span><span class="identifier">type</span><span class="special">,</span>
  39     <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="special">&gt;</span>
  40 <span class="identifier">mismatch</span><span class="special">(</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>
  41
  42 <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">&gt;</span>
  43 <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span>
  44     <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&gt;::</span><span class="identifier">type</span><span class="special">,</span>
  45     <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="special">&gt;</span>
  46 <span class="identifier">mismatch</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>
  47
  48 <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">&gt;</span>
  49 <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span>
  50     <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="identifier">SinglePassRange1</span><span class="special">&gt;::</span><span class="identifier">type</span><span class="special">,</span>
  51     <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="identifier">SinglePassRange2</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="special">&gt;</span>
  52 <span class="identifier">mismatch</span><span class="special">(</span><span class="identifier">SinglePassRange1</span><span class="special">&amp;</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="identifier">SinglePassRange2</span><span class="special">&amp;</span> <span class="identifier">rng2</span><span class="special">);</span>
  53
  54 <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">&gt;</span>
  55 <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span>
  56     <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&gt;::</span><span class="identifier">type</span><span class="special">,</span>
  57     <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="identifier">SinglePassRange2</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="special">&gt;</span>
  58 <span class="identifier">mismatch</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="identifier">SinglePassRange2</span><span class="special">&amp;</span> <span class="identifier">rng2</span><span class="special">);</span>
  59
  60
  61 <span class="keyword">template</span><span class="special">&lt;</span>
  62     <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span>
  63     <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span>
  64     <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span>
  65     <span class="special">&gt;</span>
  66 <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span>
  67     <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="identifier">SinglePassRange1</span><span class="special">&gt;::</span><span class="identifier">type</span><span class="special">,</span>
  68     <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="special">&gt;</span>
  69 <span class="identifier">mismatch</span><span class="special">(</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>
  70          <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span>
  71
  72 <span class="keyword">template</span><span class="special">&lt;</span>
  73     <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span>
  74     <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span>
  75     <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span>
  76     <span class="special">&gt;</span>
  77 <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span>
  78     <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&gt;::</span><span class="identifier">type</span><span class="special">,</span>
  79     <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="special">&gt;</span>
  80 <span class="identifier">mismatch</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>
  81          <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span>
  82
  83 <span class="keyword">template</span><span class="special">&lt;</span>
  84     <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span>
  85     <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span>
  86     <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span>
  87     <span class="special">&gt;</span>
  88 <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span>
  89     <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="identifier">SinglePassRange1</span><span class="special">&gt;::</span><span class="identifier">type</span><span class="special">,</span>
  90     <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="identifier">SinglePassRange2</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="special">&gt;</span>
  91 <span class="identifier">mismatch</span><span class="special">(</span><span class="identifier">SinglePassRange1</span><span class="special">&amp;</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="identifier">SinglePassRange2</span><span class="special">&amp;</span> <span class="identifier">rng2</span><span class="special">,</span>
  92          <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span>
  93
  94 <span class="keyword">template</span><span class="special">&lt;</span>
  95     <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span>
  96     <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span>
  97     <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span>
  98     <span class="special">&gt;</span>
  99 <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span>
 100     <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&gt;::</span><span class="identifier">type</span><span class="special">,</span>
 101     <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="identifier">SinglePassRange2</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="special">&gt;</span>
 102 <span class="identifier">mismatch</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="identifier">SinglePassRange2</span><span class="special">&amp;</span> <span class="identifier">rng2</span><span class="special">,</span>
 103          <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span>
 104 </pre>
 105 <p>
 106           </p>
 107 <a name="range.reference.algorithms.non_mutating.mismatch.description"></a><h6>
 108 <a name="id728481"></a>
 109             <a class="link" href="mismatch.html#range.reference.algorithms.non_mutating.mismatch.description">Description</a>
 110           </h6>
 111 <p>
 112             <code class="computeroutput"><span class="identifier">mismatch</span></code> finds the first
 113             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>
 114             are not equal.
 115           </p>
 116 <p>
 117             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.
 118           </p>
 119 <a name="range.reference.algorithms.non_mutating.mismatch.definition"></a><h6>
 120 <a name="id728578"></a>
 121             <a class="link" href="mismatch.html#range.reference.algorithms.non_mutating.mismatch.definition">Definition</a>
 122           </h6>
 123 <p>
 124             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>
 125           </p>
 126 <a name="range.reference.algorithms.non_mutating.mismatch.requirements"></a><h6>
 127 <a name="id728648"></a>
 128             <a class="link" href="mismatch.html#range.reference.algorithms.non_mutating.mismatch.requirements">Requirements</a>
 129           </h6>
 130 <p>
 131             <span class="bold"><strong>For the non-predicate versions:</strong></span>
 132           </p>
 133 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 134 <li class="listitem">
 135                 <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>
 136                 is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single
 137                 Pass Range</a> Concept.
 138               </li>
 139 <li class="listitem">
 140                 <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>
 141                 is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single
 142                 Pass Range</a> Concept.
 143               </li>
 144 <li class="listitem">
 145                 <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s
 146                 value type is a model of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>.
 147               </li>
 148 <li class="listitem">
 149                 <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s
 150                 value type is a model of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>.
 151               </li>
 152 <li class="listitem">
 153                 <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>s
 154                 value type can be compared for equality with <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s
 155                 value type.
 156               </li>
 157 </ul></div>
 158 <p>
 159             <span class="bold"><strong>For the predicate versions:</strong></span>
 160           </p>
 161 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 162 <li class="listitem">
 163                 <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>
 164                 is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single
 165                 Pass Range</a> Concept.
 166               </li>
 167 <li class="listitem">
 168                 <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>
 169                 is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single
 170                 Pass Range</a> Concept.
 171               </li>
 172 <li class="listitem">
 173                 <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is
 174                 a model of the <code class="computeroutput"><span class="identifier">BinaryPredicateConcept</span></code>.
 175               </li>
 176 <li class="listitem">
 177                 <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s
 178                 value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s
 179                 first argument type.
 180               </li>
 181 <li class="listitem">
 182                 <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s
 183                 value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s
 184                 second argument type.
 185               </li>
 186 </ul></div>
 187 <a name="range.reference.algorithms.non_mutating.mismatch.precondition_"></a><h6>
 188 <a name="id728960"></a>
 189             <a class="link" href="mismatch.html#range.reference.algorithms.non_mutating.mismatch.precondition_">Precondition:</a>
 190           </h6>
 191 <p>
 192             <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>
 193           </p>
 194 <a name="range.reference.algorithms.non_mutating.mismatch.complexity"></a><h6>
 195 <a name="id729032"></a>
 196             <a class="link" href="mismatch.html#range.reference.algorithms.non_mutating.mismatch.complexity">Complexity</a>
 197           </h6>
 198 <p>
 199             Linear. At most <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span></code> comparisons.
 200           </p>
 201 </div>
 202 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 203 <td align="left"></td>
 204 <td align="right"><div class="copyright-footer">Copyright &#169; 2003 -2010 Thorsten Ottosen, Neil Groves<p>
 205         Distributed under the Boost Software License, Version 1.0. (See accompanying
 206         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>)
 207       </p>
 208 </div></td>
 209 </tr></table>
 210 <hr>
 211 <div class="spirit-nav">
 212 <a accesskey="p" href="min_element.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.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="search.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 213 </div>
 214 </body>
 215 </html>