Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/algorithm/ranges/search"

From cppreference.com
< cpp‎ | algorithm‎ | ranges
(created page for ranges::search + example)
 
m (Example: -'.' (-6)
 
(8 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
{{cpp/algorithm/ranges/navbar}}
 
{{cpp/algorithm/ranges/navbar}}
 
{{dcl begin}}
 
{{dcl begin}}
{{dcl header | algorithm}}
+
{{dcl header|algorithm}}
 
{{dcl h|Call signature}}
 
{{dcl h|Call signature}}
{{dcl | num=1 | since=c++20 |1=
+
{{dcl|num=1|since=c++20|1=
template<std::forward_iterator I1, std::sentinel_for<I1> S1,
+
template< std::forward_iterator I1, std::sentinel_for<I1> S1,
        std::forward_iterator I2, std::sentinel_for<I2> S2,
+
          std::forward_iterator I2, std::sentinel_for<I2> S2,
        class Pred = ranges::equal_to,
+
          class Pred = ranges::equal_to,
        class Proj1 = std::identity,
+
          class Proj1 = std::identity,
        class Proj2 = std::identity>
+
          class Proj2 = std::identity >
  requires std::indirectly_comparable<I1, I2, Pred, Proj1, Proj2>
+
requires std::indirectly_comparable<I1, I2, Pred, Proj1, Proj2>
  constexpr ranges::subrange<I1>
+
constexpr ranges::subrange<I1>
     ranges::search(I1 first1, S1 last1, I2 first2, S2 last2, Pred pred = {},
+
     search( I1 first1, S1 last1, I2 first2, S2 last2, Pred pred = {},
                  Proj1 proj1 = {}, Proj2 proj2 = {});
+
            Proj1 proj1 = {}, Proj2 proj2 = {} );
 
}}
 
}}
{{dcl | num=2 | since=c++20 |1=
+
{{dcl|num=2|since=c++20|1=
template<std::forward_range R1, std::forward_range R2,
+
template< ranges::forward_range R1, ranges::forward_range R2,
        class Pred = ranges::equal_to,
+
          class Pred = ranges::equal_to,
        class Proj1 = std::identity,
+
          class Proj1 = std::identity,
        class Proj2 = std::identity>
+
          class Proj2 = std::identity>
  requires std::indirectly_comparable<ranges::iterator_t<R1>,
+
requires std::indirectly_comparable<ranges::iterator_t<R1>,
                                      ranges::iterator_t<R2>, Pred, Proj1, Proj2>
+
                                    ranges::iterator_t<R2>, Pred, Proj1, Proj2>
  constexpr ranges::borrowed_subrange_t<R1>
+
constexpr ranges::borrowed_subrange_t<R1>
     ranges::search(R1&& r1, R2&& r2, Pred pred = {},
+
     search( R1&& r1, R2&& r2, Pred pred = {}, Proj1 proj1 = {}, Proj2 proj2 = {} );
                  Proj1 proj1 = {}, Proj2 proj2 = {});
+
 
}}
 
}}
 
{{dcl end}}
 
{{dcl end}}
  
@1@ Searches for the ''first'' occurrence of the sequence of elements {{tt|[first2, last2)}} in the range {{tt|[first1, last1)}}. Elements are compared using binary predicate {{tt|pred}} after being projected with {{tt|proj2}} and {{tt|proj1}}, respectively.
+
@1@ Searches for the ''first'' occurrence of the sequence of elements {{range|first2|last2}} in the range {{range|first1|last1}}. Elements are compared using binary predicate {{c|pred}} after being projected with {{c|proj2}} and {{c|proj1}}, respectively.
  
@2@ Same as {{v|1}}, but uses {{tt|r1}} as the first source range and {{tt|r2}} as the second source range, as if using {{c|ranges::begin(r1)}} as {{tt|first1}}, {{c|ranges::end(r1)}} as {{tt|last1}}, {{c|ranges::begin(r2)}} as {{tt|first2}}, and {{c|ranges::end(r2)}} as {{tt|last2}}.
+
@2@ Same as {{v|1}}, but uses {{c|r1}} as the first source range and {{c|r2}} as the second source range, as if using {{c|ranges::begin(r1)}} as {{c|first1}}, {{c|ranges::end(r1)}} as {{c|last1}}, {{c|ranges::begin(r2)}} as {{c|first2}}, and {{c|ranges::end(r2)}} as {{c|last2}}.
  
 
{{cpp/ranges/niebloid}}
 
{{cpp/ranges/niebloid}}
Line 36: Line 35:
 
===Parameters===
 
===Parameters===
 
{{par begin}}
 
{{par begin}}
{{par | first1, last1 | the range of elements to examine (aka ''haystack'')}}
+
{{par|first1, last1|the range of elements to examine (aka ''haystack'')}}
{{par | first2, last2 | the range of elements to search for (aka ''needle'')}}
+
{{par|first2, last2|the range of elements to search for (aka ''needle'')}}
{{par | r1 | the range of elements to examine (aka ''haystack'')}}
+
{{par|r1|the range of elements to examine (aka ''haystack'')}}
{{par | r2 | the range of elements to search for (aka ''needle'')}}
+
{{par|r2|the range of elements to search for (aka ''needle'')}}
{{par | pred | binary predicate to apply to the projected elements}}
+
{{par|pred|binary predicate to apply to the projected elements}}
{{par | proj1 | projection to apply to the elements in the first range}}
+
{{par|proj1|projection to apply to the elements in the first range}}
{{par | proj2 | projection to apply to the elements in the second range}}
+
{{par|proj2|projection to apply to the elements in the second range}}
 
{{par end}}
 
{{par end}}
  
 
===Return value===
 
===Return value===
@1@ Returns a {{c|ranges::subrange}} object that is the first occurrence of the sequence {{tt|[first2, last2)}} (aka ''needle'') in the range {{tt|[first1, last1)}} (aka ''haystack''), after application of the projections {{tt|proj1}} and {{tt|proj2}} to the elements of both sequences respecivelly with consequensing application of the binary predicate {{tt|pred}} to compare projected elements.
+
@1@ Returns a {{c|ranges::subrange}} value that is the first occurrence of the sequence {{range|first2|last2}} (aka ''needle'') in the range {{range|first1|last1}} (aka ''haystack''), after application of the projections {{c|proj1}} and {{c|proj2}} to the elements of both sequences respectively with consequencing application of the binary predicate {{c|pred}} to compare projected elements.
 
If no such occurrence is found, {{c|ranges::subrange{last1, last1} }} is returned.
 
If no such occurrence is found, {{c|ranges::subrange{last1, last1} }} is returned.
If the range to search for (aka ''needle'') is empty, that is {{tt|first2 {{==}} last2}}, then the {{c|ranges::subrange{first1, first1} }} is returned.
+
If the range to search for (aka ''needle'') is empty, that is {{c|1=first2 == last2}}, then the {{c|ranges::subrange{first1, first1} }} is returned.
@2@ same as {{v|1}} but the returned object is {{c|ranges::borrowed_subrange_t<R1>}}.
+
@2@ Same as {{v|1}} but the return type is {{c|ranges::borrowed_subrange_t<R1>}}.
  
 
===Complexity===
 
===Complexity===
At most {{tt|S*N}} applications of the corresponding predicate and each projection, where {{c|S {{=}} last2 - first2}} and {{c|N {{=}} last1 - first1}} for {{v|1}}, or {{c|S {{=}} ranges::size(r2)}} and {{c|N {{=}} ranges::size(r1)}} for {{v|2}}.
+
At most {{tt|S * N}} applications of the corresponding predicate and each projection, where <br>
 
+
{{v|1}} {{c|1=S = ranges::distance(first2, last2)}} and {{c|1=N = ranges::distance(first1, last1)}}; <br>
<!-- ===Notes=== -->
+
{{v|2}} {{c|1=S = ranges::distance(r2)}} and {{c|1=N = ranges::distance(r1)}}.
  
 
===Possible implementation===
 
===Possible implementation===
Line 60: Line 59:
 
struct search_fn
 
struct search_fn
 
{
 
{
  template<std::forward_iterator I1, std::sentinel_for<I1> S1,
+
    template<std::forward_iterator I1, std::sentinel_for<I1> S1,
        std::forward_iterator I2, std::sentinel_for<I2> S2,
+
            std::forward_iterator I2, std::sentinel_for<I2> S2,
        class Pred = ranges::equal_to,
+
            class Pred = ranges::equal_to,
        class Proj1 = std::identity,
+
            class Proj1 = std::identity,
        class Proj2 = std::identity>
+
            class Proj2 = std::identity>
  requires std::indirectly_comparable<I1, I2, Pred, Proj1, Proj2>
+
    requires std::indirectly_comparable<I1, I2, Pred, Proj1, Proj2>
  constexpr ranges::subrange<I1>
+
    constexpr ranges::subrange<I1>
    operator()(I1 first1, S1 last1, I2 first2, S2 last2, Pred pred = {},
+
        operator()(I1 first1, S1 last1, I2 first2, S2 last2, Pred pred = {},
              Proj1 proj1 = {}, Proj2 proj2 = {}) const {
+
                  Proj1 proj1 = {}, Proj2 proj2 = {}) const
         for (;; ++first1) {
+
    {
          I1 it1 = first1;
+
         for (;; ++first1)
          for (I2 it2 = first2;; ++it1, ++it2) {
+
        {
             if (it2 == last2) return {first1, it1};
+
            I1 it1 = first1;
            if (it1 == last1) return {it1, it1};
+
            for (I2 it2 = first2;; ++it1, ++it2)
            if (!std::invoke(pred, std::invoke(proj1, *it1), std::invoke(proj2, *it2)))
+
             {
              break;
+
                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<std::forward_range R1, std::forward_range R2,
+
    template<ranges::forward_range R1, ranges::forward_range R2,
        class Pred = ranges::equal_to,
+
            class Pred = ranges::equal_to,
        class Proj1 = std::identity,
+
            class Proj1 = std::identity,
        class Proj2 = std::identity>
+
            class Proj2 = std::identity>
  requires std::indirectly_comparable<ranges::iterator_t<R1>,
+
    requires std::indirectly_comparable<ranges::iterator_t<R1>,
                                      ranges::iterator_t<R2>, Pred, Proj1, Proj2>
+
                                        ranges::iterator_t<R2>, Pred, Proj1, Proj2>
  constexpr ranges::borrowed_subrange_t<R1>
+
    constexpr ranges::borrowed_subrange_t<R1>
    operator()(R1&& r1, R2&& r2, Pred pred = {},
+
        operator()(R1&& r1, R2&& r2, Pred pred = {},
              Proj1 proj1 = {}, Proj2 proj2 = {}) const {
+
                  Proj1 proj1 = {}, Proj2 proj2 = {}) const
      return (*this)(ranges::begin(r1), ranges::end(r1),
+
    {
                    ranges::begin(r2), ranges::end(r2),
+
        return (*this)(ranges::begin(r1), ranges::end(r1),
                    std::move(pred), std::move(proj1), std::move(proj2));
+
                      ranges::begin(r2), ranges::end(r2),
 +
                      std::move(pred), std::move(proj1), std::move(proj2));
 
     }
 
     }
 
};
 
};
  
inline constexpr search_fn search{};
+
inline constexpr search_fn search {};
 
}}
 
}}
  
Line 108: Line 113:
 
using namespace std::literals;
 
using namespace std::literals;
  
void print(int id, const auto& haystack, const auto& needle, const auto& found) {
+
void print(int id, const auto& haystack, const auto& needle, const auto& found)
     std::cout << id << "). search(\"" << haystack << "\", \"" << needle << "\"); ";
+
{
 +
     std::cout << id << ") search(\"" << haystack << "\", \"" << needle << "\"); ";
 
     const auto first = std::distance(haystack.begin(), found.begin());
 
     const auto first = std::distance(haystack.begin(), found.begin());
 
     const auto last = std::distance(haystack.begin(), found.end());
 
     const auto last = std::distance(haystack.begin(), found.end());
     if (found.empty()) {
+
     if (found.empty())
 
         std::cout << "not found;";
 
         std::cout << "not found;";
     } else {
+
     else
 +
    {
 
         std::cout << "found: \"";
 
         std::cout << "found: \"";
         for (const auto x: found) { std::cout << x; }
+
         for (const auto x : found)
 +
            std::cout << x;
 
         std::cout << "\";";
 
         std::cout << "\";";
 
     }
 
     }
Line 147: Line 155:
 
     print(4, haystack, awl, found4);
 
     print(4, haystack, awl, found4);
  
     // search that uses custom comparator and projections
+
     // the search uses custom comparator and projections:
 
     constexpr auto bodkin {"234"sv};
 
     constexpr auto bodkin {"234"sv};
 
     auto found5 = std::ranges::search(haystack, bodkin,
 
     auto found5 = std::ranges::search(haystack, bodkin,
 
         [](const int x, const int y) { return x == y; }, // pred
 
         [](const int x, const int y) { return x == y; }, // pred
 
         [](const int x) { return std::toupper(x); }, // proj1
 
         [](const int x) { return std::toupper(x); }, // proj1
         [](const int y) { return y + 'A' - '1'; } // proj2
+
         [](const int y) { return y + 'A' - '1'; }); // proj2
        );
+
 
     print(5, haystack, bodkin, found5);
 
     print(5, haystack, bodkin, found5);
 
}
 
}
| output=
+
|output=
1). search("abcd abcd", "bcd"); found: "bcd"; subrange: {1, 4}
+
1) search("abcd abcd", "bcd"); found: "bcd"; subrange: {1, 4}
2). 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}
+
3) search("abcd abcd", ""); not found; subrange: {0, 0}
4). search("abcd abcd", "efg"); not found; subrange: {9, 9}
+
4) search("abcd abcd", "efg"); not found; subrange: {9, 9}
5). search("abcd abcd", "234"); found: "bcd"; subrange: {1, 4}
+
5) search("abcd abcd", "234"); found: "bcd"; subrange: {1, 4}
 
}}
 
}}
  
 
===See also===
 
===See also===
 
{{dsc begin}}
 
{{dsc begin}}
{{dsc inc | cpp/algorithm/ranges/dsc adjacent_find}}
+
{{dsc inc|cpp/algorithm/ranges/dsc adjacent_find}}
{{dsc inc | cpp/algorithm/ranges/dsc find}}
+
{{dsc inc|cpp/algorithm/ranges/dsc find}}
{{dsc inc | cpp/algorithm/ranges/dsc find_end}}
+
{{dsc inc|cpp/algorithm/ranges/dsc find_end}}
{{dsc inc | cpp/algorithm/ranges/dsc find_first_of}}
+
{{dsc inc|cpp/algorithm/ranges/dsc find_first_of}}
{{dsc inc | cpp/algorithm/ranges/dsc search_n}}
+
{{dsc inc|cpp/algorithm/ranges/dsc contains}}
{{dsc inc | cpp/algorithm/dsc search}}
+
{{dsc inc|cpp/algorithm/ranges/dsc includes}}
 +
{{dsc inc|cpp/algorithm/ranges/dsc mismatch}}
 +
{{dsc inc|cpp/algorithm/ranges/dsc search_n}}
 +
{{dsc inc|cpp/algorithm/dsc search}}
 
{{dsc end}}
 
{{dsc end}}
  
 
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}
 
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}

Latest revision as of 11:45, 16 April 2023

 
 
Algorithm library
Constrained algorithms and algorithms on ranges (C++20)
Constrained algorithms, e.g. ranges::copy, ranges::sort, ...
Execution policies (C++17)
Non-modifying sequence operations
Batch operations
(C++17)
Search operations
(C++11)                (C++11)(C++11)

Modifying sequence operations
Copy operations
(C++11)
(C++11)
Swap operations
Transformation operations
Generation operations
Removing operations
Order-changing operations
(until C++17)(C++11)
(C++20)(C++20)
Sampling operations
(C++17)

Sorting and related operations
Partitioning operations
Sorting operations
Binary search operations
(on partitioned ranges)
Set operations (on sorted ranges)
Merge operations (on sorted ranges)
Heap operations
Minimum/maximum operations
(C++11)
(C++17)
Lexicographical comparison operations
Permutation operations
C library
Numeric operations
Operations on uninitialized memory
 
Constrained algorithms
All names in this menu belong to namespace std::ranges
Non-modifying sequence operations
Modifying sequence operations
Partitioning operations
Sorting operations
Binary search operations (on sorted ranges)
       
       
Set operations (on sorted ranges)
Heap operations
Minimum/maximum operations
       
       
Permutation operations
Fold operations
Numeric operations
(C++23)            
Operations on uninitialized storage
Return types
 
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 C++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 C++20)
1) Searches for the first occurrence of the sequence of elements [first2last2) in the range [first1last1). 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:

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

Contents

[edit] 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

[edit] Return value

1) Returns a ranges::subrange value that is the first occurrence of the sequence [first2last2) (aka needle) in the range [first1last1) (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>.

[edit] 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).

[edit] 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 {};

[edit] Example

#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}

[edit] See also

finds the first two adjacent items that are equal (or satisfy a given predicate)
(niebloid)[edit]
finds the first element satisfying specific criteria
(niebloid)[edit]
finds the last sequence of elements in a certain range
(niebloid)[edit]
searches for any one of a set of elements
(niebloid)[edit]
checks if the range contains the given element or subrange
(niebloid)[edit]
returns true if one sequence is a subsequence of another
(niebloid)[edit]
finds the first position where two ranges differ
(niebloid)[edit]
searches for the first occurrence of a number consecutive copies of an element in a range
(niebloid)[edit]
searches for the first occurrence of a range of elements
(function template) [edit]