stdsearch(3)
std::search - std::search
Synopsis
Defined in header<algorithm>
template <class ForwardIt1, class ForwardIt2>
ForwardIt1 search(ForwardIt1 first, ForwardIt1 last, (until C++ 20)
ForwardIt2 s_first,
ForwardIt2 s_last);
template <class ForwardIt1, class ForwardIt2>
constexpr ForwardIt1 search(ForwardIt1 first, ForwardIt1 last, (since C++ 20)
ForwardIt2 s_first,
ForwardIt2 s_last);
template <class ExecutionPolicy, class ForwardIt1, class ForwardIt2>
ForwardIt1 search(ExecutionPolicy &&policy, ForwardIt1 first, ForwardIt1 last, (2)(since C++ 17)
ForwardIt2 s_first,
ForwardIt2 s_last);
template <class ForwardIt1, class ForwardIt2, class BinaryPredicate>
ForwardIt1 search(ForwardIt1 first, ForwardIt1 last, (until C++ 20)
ForwardIt2 s_first,
ForwardIt2 s_last, BinaryPredicate p);
(1)
template <class ForwardIt1, class ForwardIt2, class BinaryPredicate>
constexpr ForwardIt1 search(ForwardIt1 first, ForwardIt1 last, (since C++ 20)
ForwardIt2 s_first,
ForwardIt2 s_last, BinaryPredicate p);
template <class ExecutionPolicy, class ForwardIt1, class ForwardIt2, class BinaryPredicate>
ForwardIt1 search(ExecutionPolicy &&policy, ForwardIt1 first, ForwardIt1 last, (3)(4)(since C++ 17)
ForwardIt2 s_first,
ForwardIt2 s_last, BinaryPredicate p);
template <class ForwardIt, class Searcher>
(since C++ 17)
ForwardIt search(ForwardIt first, ForwardIt last, (until C++ 20)
const Searcher &searcher);
(5)
template <class ForwardIt, class Searcher>
constexpr ForwardIt search(ForwardIt first, ForwardIt last, (since C++ 20)
const Searcher &searcher);
1-4) Searches for the first occurrence of the sequence of elements [s_first, s_last) in the range [first, last).
1) Elements are compared using operator==.
3) Elements are compared using the given binary predicate p.
2,4) Same as (1,3), but executed according to policy. These overloads do not participate in overload resolution unless std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> is true
5) Searches the sequence [first, last) for the pattern specified in the constructor of searcher. Effectively executes return searcher(first, last).first;. Searcher need not be CopyConstructible.The standard library provides the following searchers:
default_searcher standard C++ library search algorithm implementation
Parameters
first, last - the range of elements to examine
s_first, s_last - the range of elements to search for
policy - the execution policy to use. See execution_policy for details.
searcher - the searcher encapsulating the search algorithm and the pattern to look for
Type requirements
ForwardIt1, ForwardIt2 must meet the requirements of LegacyForwardIterator.
Searcher must meet the requirements of Searcher.
Return value
1-4) Iterator to the beginning of first occurrence of the sequence [s_first, s_last) in the range [first, last). If no such occurrence is found, last is returned. If [s_first, s_last) is empty, first is returned. (since C++11) 5) Returns the result of searcher.operator(), that is, an iterator to the location at which the substring is found or a copy of last if it was not found.
Complexity
1-4) At most S*N comparisons where S = std::distance(s_first, s_last) and N = std::distance(first, last). 5) Depends on the searcher
Exceptions
The overloads with a template parameter named ExecutionPolicy report errors as follows:
- If execution of a function invoked as part of the algorithm throws an exception and ExecutionPolicy is one of the standard_policies, std::terminate is called. For any other ExecutionPolicy, the behavior is implementation-defined.
- If the algorithm fails to allocate memory, std::bad_alloc is thrown.
Possible implementation
First version
Second version
Example
// Run this code
#include <string>
#include <algorithm>
#include <iostream>
#include <vector>
#include <functional>
template <typename Container>
bool in_quote(const Container &cont, const std::string &s)
{
return std::search(cont.begin(), cont.end(), s.begin(), s.end()) != cont.end();
}
int main()
{
std::string str = "why waste time learning, when ignorance is instantaneous?";
// str.find() can be used as well
std::cout << std::boolalpha << in_quote(str, "learning") << ‘\n’
<< in_quote(str, "lemming") << ‘\n’;
std::vector<char> vec(str.begin(), str.end());
std::cout << std::boolalpha << in_quote(vec, "learning") << ‘\n’
<< in_quote(vec, "lemming") << ‘\n’;
// The C++17 overload demo:
std::string in = "Lorem ipsum dolor sit amet, consectetur adipiscing elit,"
" sed do eiusmod tempor incididunt ut labore et dolore magna aliqua";
std::string needle = "pisci";
auto it = std::search(in.begin(), in.end(),
std::boyer_moore_searcher(
needle.begin(), needle.end()));
if (it != in.end())
std::cout << "The string " << needle << " found at offset "
<< it - in.begin() << ‘\n’;
else
std::cout << "The string " << needle << " not found\n";
}
Output:
See also