std::search

From Cppreference

Jump to: navigation, search
Defined in header <algorithm>

template< class ForwardIterator1, class ForwardIterator2 >

ForwardIterator1 search( ForwardIterator1 first, ForwardIterator1 last,

                         ForwardIterator2 s_first, ForwardIterator2 s_last );
(1)
template< class ForwardIterator1, class ForwardIterator2, class BinaryPredicate >

ForwardIterator1 search( ForwardIterator1 first, ForwardIterator1 last,

                         ForwardIterator2 s_first, ForwardIterator2 s_last, BinaryPredicate p );
(2)

Searches for the first subsequence of elements [s_first, s_last) in the range [first, last). The first version uses operator== to compare the elements, the second version uses the given binary predicate p.

Contents

[edit] Parameters

first, last - the range of elements to examine
s_first, s_last - the range of elements to search for
p - binary predicate which returns ​true if the elements should be treated as equal.

The signature of the predicate function should be equivalent to the following:

bool pred(const Type1 &a, const Type2 &b);

The signature does not need to have const &, but the function must not modify the objects passed to it.
The types Type1 and Type2 must be such that objects of types ForwardIterator1 and ForwardIterator2 can be dereferenced and then implicitly converted to Type1 and Type2 respectively.

[edit] Return value

iterator to the beginning of first subsequence [s_first, s_last) in the range [first, last). If no such subsequence is found, last is returned.

[edit] Complexity

At most S*N comparisons where S = std::distance(s_first, s_last) and N = std::distance(first, last).

[edit] Equivalent function

[edit] Example

[edit] See also

find_end
finds the last sequence of elements in a certain range
(function template)
equal
determines if two sets of elements are the same
(function template)
find
find_if
find_if_not


(C++11)
finds the first element satisfying specific criteria
(function template)
lexicographical_compare
returns true if one range is lexicographically less than another
(function template)
mismatch
finds the first position where two ranges differ
(function template)
search_n
searches for a number consecutive copies of an element in a range
(function template)