• 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_first_of</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="find_end.html" title="find_end">
10<link rel="next" href="find_if.html" title="find_if">
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="find_end.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_if.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_first_of"></a><a class="link" href="find_first_of.html" title="find_first_of">find_first_of</a>
28</h5></div></div></div>
29<h6>
30<a name="range.reference.algorithms.non_mutating.find_first_of.h0"></a>
31            <span class="phrase"><a name="range.reference.algorithms.non_mutating.find_first_of.prototype"></a></span><a class="link" href="find_first_of.html#range.reference.algorithms.non_mutating.find_first_of.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">SinglePassRange1</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">SinglePassRange1</span><span class="special">&gt;::</span><span class="identifier">type</span>
37<span class="identifier">find_first_of</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">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>
40    <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span>
41    <span class="keyword">class</span> <span class="identifier">ForwardRange2</span><span class="special">,</span>
42    <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span>
43    <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">SinglePassRange1</span><span class="special">&gt;::</span><span class="identifier">type</span>
45<span class="identifier">find_first_of</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">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>
46
47<span class="keyword">template</span><span class="special">&lt;</span>
48    <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span>
49    <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span>
50    <span class="keyword">class</span> <span class="identifier">ForwardRange2</span>
51    <span class="special">&gt;</span>
52<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special">&lt;</span><span class="identifier">SinglePassRange1</span><span class="special">,</span> <span class="identifier">re</span><span class="special">&gt;::</span><span class="identifier">type</span>
53<span class="identifier">find_first_of</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">ForwardRange2</span><span class="special">&amp;</span> <span class="identifier">rng2</span><span class="special">);</span>
54
55<span class="keyword">template</span><span class="special">&lt;</span>
56    <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span>
57    <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span>
58    <span class="keyword">class</span> <span class="identifier">ForwardRange2</span><span class="special">,</span>
59    <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span>
60    <span class="special">&gt;</span>
61<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special">&lt;</span><span class="identifier">SinglePassRange1</span><span class="special">,</span> <span class="identifier">re</span><span class="special">&gt;::</span><span class="identifier">type</span>
62<span class="identifier">find_first_of</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">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>
63</pre>
64<p>
65          </p>
66<h6>
67<a name="range.reference.algorithms.non_mutating.find_first_of.h1"></a>
68            <span class="phrase"><a name="range.reference.algorithms.non_mutating.find_first_of.description"></a></span><a class="link" href="find_first_of.html#range.reference.algorithms.non_mutating.find_first_of.description">Description</a>
69          </h6>
70<p>
71            The versions of <code class="computeroutput"><span class="identifier">find_first_of</span></code>
72            that return an iterator, return an iterator to the first occurrence in
73            <code class="computeroutput"><span class="identifier">rng1</span></code> of any of the elements
74            in <code class="computeroutput"><span class="identifier">rng2</span></code>. Equality is
75            determined by <code class="computeroutput"><span class="keyword">operator</span><span class="special">==</span></code>
76            for non-predicate versions of <code class="computeroutput"><span class="identifier">find_first_of</span></code>,
77            and by satisfying <code class="computeroutput"><span class="identifier">pred</span></code>
78            in the predicate versions.
79          </p>
80<p>
81            The versions of <code class="computeroutput"><span class="identifier">find_first_of</span></code>
82            that return a <code class="computeroutput"><span class="identifier">range_return</span></code>,
83            defines <code class="computeroutput"><span class="identifier">found</span></code> in the
84            same manner as the returned iterator described above.
85          </p>
86<h6>
87<a name="range.reference.algorithms.non_mutating.find_first_of.h2"></a>
88            <span class="phrase"><a name="range.reference.algorithms.non_mutating.find_first_of.definition"></a></span><a class="link" href="find_first_of.html#range.reference.algorithms.non_mutating.find_first_of.definition">Definition</a>
89          </h6>
90<p>
91            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_first_of</span><span class="special">.</span><span class="identifier">hpp</span></code>
92          </p>
93<h6>
94<a name="range.reference.algorithms.non_mutating.find_first_of.h3"></a>
95            <span class="phrase"><a name="range.reference.algorithms.non_mutating.find_first_of.requirements"></a></span><a class="link" href="find_first_of.html#range.reference.algorithms.non_mutating.find_first_of.requirements">Requirements</a>
96          </h6>
97<p>
98            <span class="bold"><strong>For the non-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">SinglePassRange1</span></code>
103                is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single
104                Pass Range</a> Concept.
105              </li>
106<li class="listitem">
107                <code class="computeroutput"><span class="identifier">ForwardRange2</span></code> is
108                a model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward
109                Range</a> Concept.
110              </li>
111<li class="listitem">
112                <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s
113                value type is a model of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>,
114                and can be compared for equality with <code class="computeroutput"><span class="identifier">ForwardRange2</span></code>'s
115                value type.
116              </li>
117</ul></div>
118<p>
119            <span class="bold"><strong>For the predicate versions:</strong></span>
120          </p>
121<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
122<li class="listitem">
123                <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>
124                is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single
125                Pass Range</a> Concept.
126              </li>
127<li class="listitem">
128                <code class="computeroutput"><span class="identifier">ForwardRange2</span></code> is
129                a model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward
130                Range</a> Concept.
131              </li>
132<li class="listitem">
133                <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is
134                a model of the <code class="computeroutput"><span class="identifier">BinaryPredicateConcept</span></code>.
135              </li>
136<li class="listitem">
137                <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s
138                value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s
139                first argument type.
140              </li>
141<li class="listitem">
142                <code class="computeroutput"><span class="identifier">ForwardRange2</span></code>'s value
143                type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s
144                second argument type.
145              </li>
146</ul></div>
147<h6>
148<a name="range.reference.algorithms.non_mutating.find_first_of.h4"></a>
149            <span class="phrase"><a name="range.reference.algorithms.non_mutating.find_first_of.complexity"></a></span><a class="link" href="find_first_of.html#range.reference.algorithms.non_mutating.find_first_of.complexity">Complexity</a>
150          </h6>
151<p>
152            At most <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">*</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)</span></code> comparisons.
153          </p>
154</div>
155<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
156<td align="left"></td>
157<td align="right"><div class="copyright-footer">Copyright © 2003-2010 Thorsten Ottosen,
158      Neil Groves<p>
159        Distributed under the Boost Software License, Version 1.0. (See accompanying
160        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>)
161      </p>
162</div></td>
163</tr></table>
164<hr>
165<div class="spirit-nav">
166<a accesskey="p" href="find_end.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_if.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
167</div>
168</body>
169</html>
170