• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>search_n</title>
5<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0">
8<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms">
9<link rel="prev" href="search.html" title="search">
10<link rel="next" href="upper_bound.html" title="upper_bound">
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="search.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="upper_bound.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_n"></a><a class="link" href="search_n.html" title="search_n">search_n</a>
28</h5></div></div></div>
29<h6>
30<a name="range.reference.algorithms.non_mutating.search_n.h0"></a>
31            <span class="phrase"><a name="range.reference.algorithms.non_mutating.search_n.prototype"></a></span><a class="link" href="search_n.html#range.reference.algorithms.non_mutating.search_n.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">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Integer</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</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">ForwardRange</span><span class="special">&gt;::</span><span class="identifier">type</span>
37<span class="identifier">search_n</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Integer</span> <span class="identifier">n</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&amp;</span> <span class="identifier">value</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">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Integer</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</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">ForwardRange</span><span class="special">&gt;::</span><span class="identifier">type</span>
41<span class="identifier">search_n</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Integer</span> <span class="identifier">n</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&amp;</span> <span class="identifier">value</span><span class="special">);</span>
42
43<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Integer</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">&gt;</span>
44<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="identifier">ForwardRange</span><span class="special">&gt;::</span><span class="identifier">type</span>
45<span class="identifier">search_n</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Integer</span> <span class="identifier">n</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&amp;</span> <span class="identifier">value</span><span class="special">,</span>
46         <span class="identifier">BinaryPredicate</span> <span class="identifier">binary_pred</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">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Integer</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">&gt;</span>
49<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&gt;::</span><span class="identifier">type</span>
50<span class="identifier">search_n</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Integer</span> <span class="identifier">n</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&amp;</span> <span class="identifier">value</span><span class="special">,</span>
51         <span class="identifier">BinaryPredicate</span> <span class="identifier">binary_pred</span><span class="special">);</span>
52</pre>
53<p>
54          </p>
55<h6>
56<a name="range.reference.algorithms.non_mutating.search_n.h1"></a>
57            <span class="phrase"><a name="range.reference.algorithms.non_mutating.search_n.description"></a></span><a class="link" href="search_n.html#range.reference.algorithms.non_mutating.search_n.description">Description</a>
58          </h6>
59<p>
60            <code class="computeroutput"><span class="identifier">search_n</span></code> searches <code class="computeroutput"><span class="identifier">rng</span></code> for a sequence of length <code class="computeroutput"><span class="identifier">n</span></code> equal to <code class="computeroutput"><span class="identifier">value</span></code>
61            where equality is determined by operator== in the non-predicate case,
62            and by a predicate when one is supplied.
63          </p>
64<h6>
65<a name="range.reference.algorithms.non_mutating.search_n.h2"></a>
66            <span class="phrase"><a name="range.reference.algorithms.non_mutating.search_n.definition"></a></span><a class="link" href="search_n.html#range.reference.algorithms.non_mutating.search_n.definition">Definition</a>
67          </h6>
68<p>
69            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_n</span><span class="special">.</span><span class="identifier">hpp</span></code>
70          </p>
71<h6>
72<a name="range.reference.algorithms.non_mutating.search_n.h3"></a>
73            <span class="phrase"><a name="range.reference.algorithms.non_mutating.search_n.requirements"></a></span><a class="link" href="search_n.html#range.reference.algorithms.non_mutating.search_n.requirements">Requirements</a>
74          </h6>
75<p>
76            <span class="bold"><strong>For the non-predicate versions:</strong></span>
77          </p>
78<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
79<li class="listitem">
80                <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a
81                model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward
82                Range</a> Concept.
83              </li>
84<li class="listitem">
85                <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value
86                type is a model of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>.
87              </li>
88<li class="listitem">
89                <code class="computeroutput"><span class="identifier">ForwardRange</span></code>s value
90                type can be compared for equality with <code class="computeroutput"><span class="identifier">Value</span></code>.
91              </li>
92<li class="listitem">
93                <code class="computeroutput"><span class="identifier">Integer</span></code> is a model
94                of the <code class="computeroutput"><span class="identifier">IntegerConcept</span></code>.
95              </li>
96</ul></div>
97<p>
98            <span class="bold"><strong>For the predicate versions:</strong></span>
99          </p>
100<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
101<li class="listitem">
102                <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a
103                model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward
104                Range</a> Concept.
105              </li>
106<li class="listitem">
107                <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is
108                a model of the <code class="computeroutput"><span class="identifier">BinaryPredicateConcept</span></code>.
109              </li>
110<li class="listitem">
111                <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value
112                type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s
113                first argument type.
114              </li>
115<li class="listitem">
116                <code class="computeroutput"><span class="identifier">Value</span></code> is convertible
117                to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s
118                second argument type.
119              </li>
120<li class="listitem">
121                <code class="computeroutput"><span class="identifier">Integer</span></code> is a model
122                of the <code class="computeroutput"><span class="identifier">IntegerConcept</span></code>.
123              </li>
124</ul></div>
125<h6>
126<a name="range.reference.algorithms.non_mutating.search_n.h4"></a>
127            <span class="phrase"><a name="range.reference.algorithms.non_mutating.search_n.complexity"></a></span><a class="link" href="search_n.html#range.reference.algorithms.non_mutating.search_n.complexity">Complexity</a>
128          </h6>
129<p>
130            Average complexity is Linear. Worst-case complexity is quadratic.
131          </p>
132</div>
133<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
134<td align="left"></td>
135<td align="right"><div class="copyright-footer">Copyright © 2003-2010 Thorsten Ottosen,
136      Neil Groves<p>
137        Distributed under the Boost Software License, Version 1.0. (See accompanying
138        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>)
139      </p>
140</div></td>
141</tr></table>
142<hr>
143<div class="spirit-nav">
144<a accesskey="p" href="search.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="upper_bound.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
145</div>
146</body>
147</html>
148