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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>search</title>
   5 <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   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="mismatch.html" title="mismatch">
  10 <link rel="next" href="search_n.html" title="search_n">
  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="mismatch.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_n.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.search"></a><a class="link" href="search.html" title="search">search</a>
  28 </h5></div></div></div>
  29 <h6>
  30 <a name="range.reference.algorithms.non_mutating.search.h0"></a>
  31             <span class="phrase"><a name="range.reference.algorithms.non_mutating.search.prototype"></a></span><a class="link" href="search.html#range.reference.algorithms.non_mutating.search.prototype">Prototype</a>
  32           </h6>
  33 <p>
  34 </p>
  35 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">ForwardRange1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardRange2</span><span class="special">&gt;</span>
  36 <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="identifier">ForwardRange1</span><span class="special">&gt;::</span><span class="identifier">type</span>
  37 <span class="identifier">search</span><span class="special">(</span><span class="identifier">ForwardRange1</span><span class="special">&amp;</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&amp;</span> <span class="identifier">rng2</span><span class="special">);</span>
  38
  39 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">ForwardRange1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ForwardRange2</span><span class="special">&gt;</span>
  40 <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">ForwardRange1</span><span class="special">&gt;::</span><span class="identifier">type</span>
  41 <span class="identifier">search</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange1</span><span class="special">&amp;</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&amp;</span> <span class="identifier">rng2</span><span class="special">);</span>
  42
  43 <span class="keyword">template</span><span class="special">&lt;</span>
  44     <span class="keyword">class</span> <span class="identifier">ForwardRange1</span><span class="special">,</span>
  45     <span class="keyword">class</span> <span class="identifier">ForwardRange2</span><span class="special">,</span>
  46     <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span>
  47     <span class="special">&gt;</span>
  48 <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="identifier">ForwardRange1</span><span class="special">&gt;::</span><span class="identifier">type</span><span class="special">,</span>
  49 <span class="identifier">search</span><span class="special">(</span><span class="identifier">ForwardRange1</span><span class="special">&amp;</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&amp;</span> <span class="identifier">rng2</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span>
  50
  51 <span class="keyword">template</span><span class="special">&lt;</span>
  52     <span class="keyword">class</span> <span class="identifier">ForwardRange1</span><span class="special">,</span>
  53     <span class="keyword">class</span> <span class="identifier">ForwardRange2</span><span class="special">,</span>
  54     <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span>
  55     <span class="special">&gt;</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">ForwardRange1</span><span class="special">&gt;::</span><span class="identifier">type</span>
  57 <span class="identifier">search</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange1</span><span class="special">&amp;</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="identifier">ForwardRange2</span><span class="special">&amp;</span> <span class="identifier">rng2</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span>
  58
  59
  60 <span class="keyword">template</span><span class="special">&lt;</span>
  61     <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span>
  62     <span class="keyword">class</span> <span class="identifier">ForwardRange1</span><span class="special">,</span>
  63     <span class="keyword">class</span> <span class="identifier">ForwardRange2</span>
  64     <span class="special">&gt;</span>
  65 <span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special">&lt;</span><span class="identifier">ForwardRange1</span><span class="special">,</span> <span class="identifier">re</span><span class="special">&gt;::</span><span class="identifier">type</span>
  66 <span class="identifier">search</span><span class="special">(</span><span class="identifier">ForwardRange1</span><span class="special">&amp;</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&amp;</span> <span class="identifier">rng2</span><span class="special">);</span>
  67
  68 <span class="keyword">template</span><span class="special">&lt;</span>
  69     <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span>
  70     <span class="keyword">class</span> <span class="identifier">ForwardRange1</span><span class="special">,</span>
  71     <span class="keyword">class</span> <span class="identifier">ForwardRange2</span>
  72     <span class="special">&gt;</span>
  73 <span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">ForwardRange1</span><span class="special">,</span> <span class="identifier">re</span><span class="special">&gt;::</span><span class="identifier">type</span>
  74 <span class="identifier">search</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange1</span><span class="special">&amp;</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&amp;</span> <span class="identifier">rng2</span><span class="special">);</span>
  75
  76 <span class="keyword">template</span><span class="special">&lt;</span>
  77     <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span>
  78     <span class="keyword">class</span> <span class="identifier">ForwardRange1</span><span class="special">,</span>
  79     <span class="keyword">class</span> <span class="identifier">ForwardRange2</span><span class="special">,</span>
  80     <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span>
  81     <span class="special">&gt;</span>
  82 <span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special">&lt;</span><span class="identifier">ForwardRange1</span><span class="special">,</span> <span class="identifier">re</span><span class="special">&gt;::</span><span class="identifier">type</span><span class="special">,</span>
  83 <span class="identifier">search</span><span class="special">(</span><span class="identifier">ForwardRange1</span><span class="special">&amp;</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&amp;</span> <span class="identifier">rng2</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span>
  84
  85 <span class="keyword">template</span><span class="special">&lt;</span>
  86     <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span>
  87     <span class="keyword">class</span> <span class="identifier">ForwardRange1</span><span class="special">,</span>
  88     <span class="keyword">class</span> <span class="identifier">ForwardRange2</span><span class="special">,</span>
  89     <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span>
  90     <span class="special">&gt;</span>
  91 <span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">ForwardRange1</span><span class="special">,</span> <span class="identifier">re</span><span class="special">&gt;::</span><span class="identifier">type</span>
  92 <span class="identifier">search</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange1</span><span class="special">&amp;</span> <span class="identifier">rng1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ForwardRange2</span><span class="special">&amp;</span> <span class="identifier">rng2</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span>
  93 </pre>
  94 <p>
  95           </p>
  96 <h6>
  97 <a name="range.reference.algorithms.non_mutating.search.h1"></a>
  98             <span class="phrase"><a name="range.reference.algorithms.non_mutating.search.description"></a></span><a class="link" href="search.html#range.reference.algorithms.non_mutating.search.description">Description</a>
  99           </h6>
 100 <p>
 101             The versions of <code class="computeroutput"><span class="identifier">search</span></code>
 102             that return an iterator, return an iterator to the start of the first
 103             subsequence in <code class="computeroutput"><span class="identifier">rng1</span></code> that
 104             is equal to the subsequence <code class="computeroutput"><span class="identifier">rng2</span></code>.
 105             The <code class="computeroutput"><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span></code>
 106             is returned if no such subsequence exists in <code class="computeroutput"><span class="identifier">rng1</span></code>.
 107             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">search</span></code>, and by satisfying <code class="computeroutput"><span class="identifier">pred</span></code> in the predicate versions.
 108           </p>
 109 <p>
 110             The versions of <code class="computeroutput"><span class="identifier">search</span></code>
 111             that return a <code class="computeroutput"><span class="identifier">range_return</span></code>,
 112             defines <code class="computeroutput"><span class="identifier">found</span></code> in the
 113             same manner as the returned iterator described above.
 114           </p>
 115 <h6>
 116 <a name="range.reference.algorithms.non_mutating.search.h2"></a>
 117             <span class="phrase"><a name="range.reference.algorithms.non_mutating.search.definition"></a></span><a class="link" href="search.html#range.reference.algorithms.non_mutating.search.definition">Definition</a>
 118           </h6>
 119 <p>
 120             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">search</span><span class="special">.</span><span class="identifier">hpp</span></code>
 121           </p>
 122 <h6>
 123 <a name="range.reference.algorithms.non_mutating.search.h3"></a>
 124             <span class="phrase"><a name="range.reference.algorithms.non_mutating.search.requirements"></a></span><a class="link" href="search.html#range.reference.algorithms.non_mutating.search.requirements">Requirements</a>
 125           </h6>
 126 <p>
 127             <span class="bold"><strong>For the non-predicate versions:</strong></span>
 128           </p>
 129 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 130 <li class="listitem">
 131                 <code class="computeroutput"><span class="identifier">ForwardRange1</span></code> is
 132                 a model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward
 133                 Range</a> Concept.
 134               </li>
 135 <li class="listitem">
 136                 <code class="computeroutput"><span class="identifier">ForwardRange2</span></code> is
 137                 a model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward
 138                 Range</a> Concept.
 139               </li>
 140 <li class="listitem">
 141                 <code class="computeroutput"><span class="identifier">ForwardRange1</span></code>'s value
 142                 type is a model of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>.
 143               </li>
 144 <li class="listitem">
 145                 <code class="computeroutput"><span class="identifier">ForwardRange2</span></code>'s value
 146                 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">ForwardRange1</span></code>s value
 150                 type can be compared for equality with <code class="computeroutput"><span class="identifier">ForwardRange2</span></code>'s
 151                 value type.
 152               </li>
 153 </ul></div>
 154 <p>
 155             <span class="bold"><strong>For the predicate versions:</strong></span>
 156           </p>
 157 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 158 <li class="listitem">
 159                 <code class="computeroutput"><span class="identifier">ForwardRange1</span></code> is
 160                 a model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward
 161                 Range</a> Concept.
 162               </li>
 163 <li class="listitem">
 164                 <code class="computeroutput"><span class="identifier">ForwardRange2</span></code> is
 165                 a model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward
 166                 Range</a> Concept.
 167               </li>
 168 <li class="listitem">
 169                 <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is
 170                 a model of the <code class="computeroutput"><span class="identifier">BinaryPredicateConcept</span></code>.
 171               </li>
 172 <li class="listitem">
 173                 <code class="computeroutput"><span class="identifier">ForwardRange1</span></code>'s value
 174                 type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s
 175                 first argument type.
 176               </li>
 177 <li class="listitem">
 178                 <code class="computeroutput"><span class="identifier">ForwardRange2</span></code>'s value
 179                 type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s
 180                 second argument type.
 181               </li>
 182 </ul></div>
 183 <h6>
 184 <a name="range.reference.algorithms.non_mutating.search.h4"></a>
 185             <span class="phrase"><a name="range.reference.algorithms.non_mutating.search.complexity"></a></span><a class="link" href="search.html#range.reference.algorithms.non_mutating.search.complexity">Complexity</a>
 186           </h6>
 187 <p>
 188             Average complexity is Linear. Worst-case complexity is quadratic.
 189           </p>
 190 </div>
 191 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 192 <td align="left"></td>
 193 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2010 Thorsten Ottosen,
 194       Neil Groves<p>
 195         Distributed under the Boost Software License, Version 1.0. (See accompanying
 196         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>)
 197       </p>
 198 </div></td>
 199 </tr></table>
 200 <hr>
 201 <div class="spirit-nav">
 202 <a accesskey="p" href="mismatch.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_n.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 203 </div>
 204 </body>
 205 </html>