std::ranges::search

 

哋它亢++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (哋它亢++20)

Language support library

Concepts library (哋它亢++20)

Metaprogramming library (哋它亢++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (哋它亢++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (哋它亢++17)

Regular expressions library (哋它亢++11)

Concurrency support library (哋它亢++11)

Technical specifications

Symbols index

External libraries

 

Algorithm library

Constrained algorithms and algorithms on ranges (哋它亢++20)
Constrained algorithms, e.g. ranges::copy, ranges::sort, ...
Execution policies (哋它亢++17)
is_execution_policy (哋它亢++17)   execution::seqexecution::parexecution::par_unseqexecution::unseq (哋它亢++17)    (哋它亢++17)(哋它亢++17)(哋它亢++20)	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policyexecution::parallel_unsequenced (哋它亢++17)(哋它亢++17)(哋它亢++17)(哋它亢++20)
Non-modifying sequence operations Batch operations for_each for_each_n (哋它亢++17) Search operations all_ofany_ofnone_of (哋它亢++11)                (哋它亢++11)(哋它亢++11) countcount_if mismatch equal findfind_iffind_if_not (哋它亢++11) find_end find_first_of adjacent_find search search_n Modifying sequence operations Copy operations copycopy_if (哋它亢++11) copy_backward copy_n (哋它亢++11) move (哋它亢++11) move_backward (哋它亢++11) Swap operations swap iter_swap swap_ranges Transformation operations replacereplace_if transform replace_copyreplace_copy_if Generation operations fill fill_n generate generate_n Removing operations removeremove_if unique remove_copyremove_copy_if unique_copy Order-changing operations reverse reverse_copy rotate rotate_copy random_shuffleshuffle (until 哋它亢++17)(哋它亢++11) shift_leftshift_right (哋它亢++20)(哋它亢++20) Sampling operations sample (哋它亢++17)	Sorting and related operations Partitioning operations partition partition_copy (哋它亢++11)   stable_partition is_partitioned (哋它亢++11) partition_point (哋它亢++11) Sorting operations sort stable_sort partial_sort partial_sort_copy is_sorted (哋它亢++11) is_sorted_until (哋它亢++11) nth_element Binary search operations (on partitioned ranges) lower_bound upper_bound equal_range binary_search Set operations (on sorted ranges) includes set_union set_intersection set_difference set_symmetric_difference Merge operations (on sorted ranges) merge inplace_merge Heap operations push_heap pop_heap make_heap sort_heap is_heap (哋它亢++11) is_heap_until (哋它亢++11) Minimum/maximum operations max min minmax (哋它亢++11) clamp (哋它亢++17) max_element min_element minmax_element (哋它亢++11) Lexicographical comparison operations lexicographical_compare lexicographical_compare_three_way (哋它亢++20) Permutation operations next_permutation prev_permutation is_permutation (哋它亢++11) C library qsort bsearch
Numeric operations
iota (哋它亢++11) inner_product adjacent_difference    accumulate reduce (哋它亢++17) transform_reduce (哋它亢++17)	partial_sum inclusive_scan (哋它亢++17)    exclusive_scan (哋它亢++17) transform_inclusive_scan (哋它亢++17) transform_exclusive_scan (哋它亢++17)
Operations on uninitialized memory
uninitialized_copy uninitialized_move (哋它亢++17)    uninitialized_fill uninitialized_copy_n (哋它亢++11) uninitialized_move_n (哋它亢++17) uninitialized_fill_n	destroy (哋它亢++17) destroy_n (哋它亢++17) destroy_at (哋它亢++17) construct_at (哋它亢++20)       uninitialized_default_construct (哋它亢++17) uninitialized_value_construct (哋它亢++17) uninitialized_default_construct_n (哋它亢++17) uninitialized_value_construct_n (哋它亢++17)

 

Constrained algorithms

All names in this menu belong to namespace std::ranges

Non-modifying sequence operations

all_ofany_ofnone_of for_each for_each_n    countcount_if adjacent_find mismatch equal lexicographical_compare    containscontains_subrange (哋它亢++23)(哋它亢++23) findfind_iffind_if_not find_lastfind_last_iffind_last_if_not (哋它亢++23)(哋它亢++23)(哋它亢++23)   find_end find_first_of search search_n starts_with (哋它亢++23) ends_with (哋它亢++23)

Modifying sequence operations

copycopy_if copy_n copy_backward    move move_backward shift_leftshift_right (哋它亢++23)(哋它亢++23)   fill fill_n generate generate_n    transform swap_ranges    shuffle sample removeremove_if replacereplace_if reverse rotate remove_copyremove_copy_if    unique replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy

Partitioning operations

is_partitioned    partition_point    partition    partition_copy    stable_partition

Sorting operations

is_sorted is_sorted_until     sort stable_sort         partial_sort       nth_element partial_sort_copy

Binary search operations (on sorted ranges)

lower_bound         upper_bound         binary_search      equal_range

Set operations (on sorted ranges)

merge inplace_merge       set_difference set_intersection    set_union          includes set_symmetric_difference

Heap operations

is_heap is_heap_until       make_heap           sort_heap push_heap pop_heap

Minimum/maximum operations

max max_element         min min_element         minmax minmax_element     clamp

Permutation operations

is_permutation      next_permutation    prev_permutation

Fold operations

fold_left (哋它亢++23) fold_left_first (哋它亢++23)   fold_right (哋它亢++23) fold_right_last (哋它亢++23)   fold_left_with_iter (哋它亢++23) fold_left_first_with_iter (哋它亢++23)

Numeric operations iota (哋它亢++23)             Random number generation generate_random (哋它亢++26)

Operations on uninitialized storage

construct_at    destroy destroy_n destroy_at uninitialized_copy    uninitialized_move uninitialized_fill uninitialized_copy_n    uninitialized_move_n uninitialized_fill_n uninitialized_default_construct uninitialized_default_construct_n uninitialized_value_construct uninitialized_value_construct_n

Return types

in_fun_result in_in_result in_found_result    in_out_result in_in_out_result    in_out_out_result    min_max_result out_value_result (哋它亢++23) in_value_result (哋它亢++23)

 

Defined in header <algorithm>
Call signature
template< std::forward_iterator I1, std::sentinel_for<I1> S1,           std::forward_iterator I2, std::sentinel_for<I2> S2,           class Pred = ranges::equal_to,           class Proj1 = std::identity,           class Proj2 = std::identity > requires std::indirectly_comparable<I1, I2, Pred, Proj1, Proj2> constexpr ranges::subrange<I1>     search( I1 first1, S1 last1, I2 first2, S2 last2, Pred pred = {},             Proj1 proj1 = {}, Proj2 proj2 = {} );	(1)	(since 哋它亢++20)
template< ranges::forward_range R1, ranges::forward_range R2,           class Pred = ranges::equal_to,           class Proj1 = std::identity,           class Proj2 = std::identity> requires std::indirectly_comparable<ranges::iterator_t<R1>,                                     ranges::iterator_t<R2>, Pred, Proj1, Proj2> constexpr ranges::borrowed_subrange_t<R1>     search( R1&& r1, R2&& r2, Pred pred = {}, Proj1 proj1 = {}, Proj2 proj2 = {} );	(2)	(since 哋它亢++20)

1) Searches for the first occurrence of the sequence of elements [first2, last2) in the range [first1, last1). Elements are compared using binary predicate pred after being projected with proj2 and proj1, respectively.

2) Same as (1), but uses r1 as the first source range and r2 as the second source range, as if using ranges::begin(r1) as first1, ranges::end(r1) as last1, ranges::begin(r2) as first2, and ranges::end(r2) as last2.

The function-like entities described on this page are niebloids, that is:

• Explicit template argument lists cannot be specified when calling any of them.
• None of them are visible to argument-dependent lookup.
• When any of them are found by normal unqualified lookup as the name to the left of the function-call operator, argument-dependent lookup is inhibited.

In practice, they may be implemented as function objects, or with special compiler extensions.

Parameters

first1, last1	-	the range of elements to examine (aka haystack)
first2, last2	-	the range of elements to search for (aka needle)
r1	-	the range of elements to examine (aka haystack)
r2	-	the range of elements to search for (aka needle)
pred	-	binary predicate to apply to the projected elements
proj1	-	projection to apply to the elements in the first range
proj2	-	projection to apply to the elements in the second range

Return value

1) Returns a ranges::subrange value that is the first occurrence of the sequence [first2, last2) (aka needle) in the range [first1, last1) (aka haystack), after application of the projections proj1 and proj2 to the elements of both sequences respectively with consequencing application of the binary predicate pred to compare projected elements.

If no such occurrence is found, ranges::subrange{last1, last1} is returned.

If the range to search for (aka needle) is empty, that is first2 == last2, then the ranges::subrange{first1, first1} is returned.

2) Same as (1) but the return type is ranges::borrowed_subrange_t<R1>.

Complexity

At most S * N applications of the corresponding predicate and each projection, where
(1) S = ranges::distance(first2, last2) and N = ranges::distance(first1, last1);
(2) S = ranges::distance(r2) and N = ranges::distance(r1).

Possible implementation

struct search_fn { template<std::forward_iterator I1, std::sentinel_for<I1> S1, std::forward_iterator I2, std::sentinel_for<I2> S2, class Pred = ranges::equal_to, class Proj1 = std::identity, class Proj2 = std::identity> requires std::indirectly_comparable<I1, I2, Pred, Proj1, Proj2> constexpr ranges::subrange<I1> operator()(I1 first1, S1 last1, I2 first2, S2 last2, Pred pred = {}, Proj1 proj1 = {}, Proj2 proj2 = {}) const { for (;; ++first1) { I1 it1 = first1; for (I2 it2 = first2;; ++it1, ++it2) { if (it2 == last2) return {first1, it1}; if (it1 == last1) return {it1, it1}; if (!std::invoke(pred, std::invoke(proj1, *it1), std::invoke(proj2, *it2))) break; } } }   template<ranges::forward_range R1, ranges::forward_range R2, class Pred = ranges::equal_to, class Proj1 = std::identity, class Proj2 = std::identity> requires std::indirectly_comparable<ranges::iterator_t<R1>, ranges::iterator_t<R2>, Pred, Proj1, Proj2> constexpr ranges::borrowed_subrange_t<R1> operator()(R1&& r1, R2&& r2, Pred pred = {}, Proj1 proj1 = {}, Proj2 proj2 = {}) const { return (*this)(ranges::begin(r1), ranges::end(r1), ranges::begin(r2), ranges::end(r2), std::move(pred), std::move(proj1), std::move(proj2)); } };   inline constexpr search_fn search {};

Example

Run this code

#include <algorithm>
#include <cctype>
#include <iostream>
#include <iterator>
#include <string_view>
 
using namespace std::literals;
 
void print(int id, const auto& haystack, const auto& needle, const auto& found)
{
    std::cout << id << ") search(\"" << haystack << "\", \"" << needle << "\"); ";
    const auto first = std::distance(haystack.begin(), found.begin());
    const auto last = std::distance(haystack.begin(), found.end());
    if (found.empty())
        std::cout << "not found;";
    else
    {
        std::cout << "found: \"";
        for (const auto x : found)
            std::cout << x;
        std::cout << "\";";
    }
    std::cout << " subrange: {" << first << ", " << last << "}\n";
}
 
int main()
{
    constexpr auto haystack {"abcd abcd"sv};
    constexpr auto needle {"bcd"sv};
 
    // the search uses iterator pairs begin()/end():
    constexpr auto found1 = std::ranges::search(
        haystack.begin(), haystack.end(),
        needle.begin(), needle.end());
    print(1, haystack, needle, found1);
 
    // the search uses ranges r1, r2:
    constexpr auto found2 = std::ranges::search(haystack, needle);
    print(2, haystack, needle, found2);
 
    // 'needle' range is empty:
    constexpr auto none {""sv};
    constexpr auto found3 = std::ranges::search(haystack, none);
    print(3, haystack, none, found3);
 
    // 'needle' will not be found:
    constexpr auto awl {"efg"sv};
    constexpr auto found4 = std::ranges::search(haystack, awl);
    print(4, haystack, awl, found4);
 
    // the search uses custom comparator and projections:
    constexpr auto bodkin {"234"sv};
    auto found5 = std::ranges::search(haystack, bodkin,
        [](const int x, const int y) { return x == y; }, // pred
        [](const int x) { return std::toupper(x); }, // proj1
        [](const int y) { return y + 'A' - '1'; }); // proj2
    print(5, haystack, bodkin, found5);
}

Output:

1) search("abcd abcd", "bcd"); found: "bcd"; subrange: {1, 4}
2) search("abcd abcd", "bcd"); found: "bcd"; subrange: {1, 4}
3) search("abcd abcd", ""); not found; subrange: {0, 0}
4) search("abcd abcd", "efg"); not found; subrange: {9, 9}
5) search("abcd abcd", "234"); found: "bcd"; subrange: {1, 4}

See also

ranges::adjacent_find (哋它亢++20)	finds the first two adjacent items that are equal (or satisfy a given predicate) (niebloid)
ranges::findranges::find_ifranges::find_if_not (哋它亢++20)(哋它亢++20)(哋它亢++20)	finds the first element satisfying specific criteria (niebloid)
ranges::find_end (哋它亢++20)	finds the last sequence of elements in a certain range (niebloid)
ranges::find_first_of (哋它亢++20)	searches for any one of a set of elements (niebloid)
ranges::containsranges::contains_subrange (哋它亢++23)(哋它亢++23)	checks if the range contains the given element or subrange (niebloid)
ranges::includes (哋它亢++20)	returns true if one sequence is a subsequence of another (niebloid)
ranges::mismatch (哋它亢++20)	finds the first position where two ranges differ (niebloid)
ranges::search_n (哋它亢++20)	searches for a number consecutive copies of an element in a range (niebloid)
search	searches for a range of elements (function template)