• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>find</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="for_each.html" title="for_each">
10<link rel="next" href="find_end.html" title="find_end">
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="for_each.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="find_end.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.find"></a><a class="link" href="find.html" title="find">find</a>
28</h5></div></div></div>
29<h6>
30<a name="range.reference.algorithms.non_mutating.find.h0"></a>
31            <span class="phrase"><a name="range.reference.algorithms.non_mutating.find.prototype"></a></span><a class="link" href="find.html#range.reference.algorithms.non_mutating.find.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">SinglePassRange</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">SinglePassRange</span><span class="special">&gt;::</span><span class="identifier">type</span>
37<span class="identifier">find</span><span class="special">(</span><span class="identifier">SinglePassRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Value</span> <span class="identifier">val</span><span class="special">);</span>
38
39<span class="keyword">template</span><span class="special">&lt;</span>
40    <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span>
41    <span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span>
42    <span class="keyword">class</span> <span class="identifier">Value</span>
43    <span class="special">&gt;</span>
44<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special">&lt;</span><span class="identifier">SinglePassRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">&gt;::</span><span class="identifier">type</span>
45<span class="identifier">find</span><span class="special">(</span><span class="identifier">SinglePassRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Value</span> <span class="identifier">val</span><span class="special">);</span>
46</pre>
47<p>
48          </p>
49<h6>
50<a name="range.reference.algorithms.non_mutating.find.h1"></a>
51            <span class="phrase"><a name="range.reference.algorithms.non_mutating.find.description"></a></span><a class="link" href="find.html#range.reference.algorithms.non_mutating.find.description">Description</a>
52          </h6>
53<p>
54            The versions of <code class="computeroutput"><span class="identifier">find</span></code>
55            that return an iterator, returns the first iterator in the range <code class="computeroutput"><span class="identifier">rng</span></code> such that <code class="computeroutput"><span class="special">*</span><span class="identifier">i</span> <span class="special">==</span> <span class="identifier">value</span></code>. <code class="computeroutput"><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> is returned if no such iterator exists.
56            The versions of find that return a <code class="computeroutput"><span class="identifier">range_return</span></code>,
57            defines <code class="computeroutput"><span class="identifier">found</span></code> in the
58            same manner as the returned iterator described above.
59          </p>
60<h6>
61<a name="range.reference.algorithms.non_mutating.find.h2"></a>
62            <span class="phrase"><a name="range.reference.algorithms.non_mutating.find.definition"></a></span><a class="link" href="find.html#range.reference.algorithms.non_mutating.find.definition">Definition</a>
63          </h6>
64<p>
65            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">find</span><span class="special">.</span><span class="identifier">hpp</span></code>
66          </p>
67<h6>
68<a name="range.reference.algorithms.non_mutating.find.h3"></a>
69            <span class="phrase"><a name="range.reference.algorithms.non_mutating.find.requirements"></a></span><a class="link" href="find.html#range.reference.algorithms.non_mutating.find.requirements">Requirements</a>
70          </h6>
71<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
72<li class="listitem">
73                <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is
74                a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single
75                Pass Range</a> Concept.
76              </li>
77<li class="listitem">
78                <code class="computeroutput"><span class="identifier">Value</span></code> is a model
79                of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>.
80              </li>
81<li class="listitem">
82                The <code class="computeroutput"><span class="keyword">operator</span><span class="special">==</span></code>
83                is defined for type <code class="computeroutput"><span class="identifier">Value</span></code>
84                to be compared with the <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>'s
85                value type.
86              </li>
87</ul></div>
88<h6>
89<a name="range.reference.algorithms.non_mutating.find.h4"></a>
90            <span class="phrase"><a name="range.reference.algorithms.non_mutating.find.complexity"></a></span><a class="link" href="find.html#range.reference.algorithms.non_mutating.find.complexity">Complexity</a>
91          </h6>
92<p>
93            Linear. At most <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> comparisons for equality.
94          </p>
95</div>
96<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
97<td align="left"></td>
98<td align="right"><div class="copyright-footer">Copyright © 2003-2010 Thorsten Ottosen,
99      Neil Groves<p>
100        Distributed under the Boost Software License, Version 1.0. (See accompanying
101        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>)
102      </p>
103</div></td>
104</tr></table>
105<hr>
106<div class="spirit-nav">
107<a accesskey="p" href="for_each.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="find_end.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
108</div>
109</body>
110</html>
111