Difference between revisions of "cpp/algorithm/ranges/contains"
m (FTM.) |
|||
(24 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
− | {{cpp/ranges/title| contains | contains_subrange}} | + | {{cpp/ranges/title|contains|contains_subrange}} |
{{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 | | + | {{dcl rev multi|num=1|anchor=1|since1=c++23|until1=c++26|dcl1= |
− | template< | + | template< std::input_iterator I, std::sentinel_for<I> S, |
− | requires | + | class T, |
− | constexpr bool ranges::contains(I first, S last, const T& value, Proj proj = {}); | + | class Proj = std::identity > |
+ | requires std::indirect_binary_predicate<ranges::equal_to, std::projected<I, Proj>, | ||
+ | const T*> | ||
+ | constexpr bool contains( I first, S last, const T& value, Proj proj = {} ); | ||
+ | |dcl2= | ||
+ | template< std::input_iterator I, std::sentinel_for<I> S, | ||
+ | class Proj = std::identity, | ||
+ | class T = std::projected_value_t<I, Proj> > | ||
+ | requires std::indirect_binary_predicate<ranges::equal_to, std::projected<I, Proj>, | ||
+ | const T*> | ||
+ | constexpr bool contains( I first, S last, const T& value, Proj proj = {} ); | ||
}} | }} | ||
− | {{dcl | | + | {{dcl rev multi|num=2|since1=c++23|until1=c++26|dcl1= |
− | template< | + | template< ranges::input_range R, |
− | requires | + | class T, |
− | constexpr bool ranges::contains(R&& r, const T& value, Proj proj = {}); | + | class Proj = std::identity > |
+ | requires std::indirect_binary_predicate<ranges::equal_to, | ||
+ | std::projected<ranges::iterator_t<R>, Proj>, | ||
+ | const T*> | ||
+ | constexpr bool contains( R&& r, const T& value, Proj proj = {} ); | ||
+ | |dcl2= | ||
+ | template< ranges::input_range R, | ||
+ | class Proj = std::identity, | ||
+ | class T = std::projected_value_t<ranges::iterator_t<R>, Proj> > | ||
+ | requires std::indirect_binary_predicate<ranges::equal_to, | ||
+ | std::projected<ranges::iterator_t<R>, Proj>, | ||
+ | const T*> | ||
+ | constexpr bool contains( R&& r, const T& value, Proj proj = {} ); | ||
}} | }} | ||
− | {{ | + | {{dcla|since=c++23|num=3|1= |
− | template< | + | template< std::forward_iterator I1, std::sentinel_for<I1> S1, |
− | + | std::forward_iterator I2, std::sentinel_for<I2> S2, | |
− | + | class Pred = ranges::equal_to, | |
− | requires | + | class Proj1 = std::identity, class Proj2 = std::identity > |
− | constexpr bool | + | requires std::indirectly_comparable<I1, I2, Pred, Proj1, Proj2> |
− | + | constexpr bool contains_subrange( I1 first1, S1 last1, I2 first2, S2 last2, | |
+ | Pred pred = {}, | ||
+ | Proj1 proj1 = {}, Proj2 proj2 = {} ); | ||
}} | }} | ||
− | {{dcl | since=c++23 | num= 4 |1= | + | {{dcl|since=c++23|num=4|1= |
− | template< | + | template< ranges::forward_range R1, ranges::forward_range R2, |
− | + | class Pred = ranges::equal_to, | |
− | requires | + | class Proj1 = std::identity, class Proj2 = std::identity > |
− | constexpr bool | + | requires std::indirectly_comparable<ranges::iterator_t<R1>, |
− | + | ranges::iterator_t<R2>, Pred, Proj1, Proj2> | |
+ | constexpr bool contains_subrange( R1&& r1, R2&& r2, Pred pred = {}, | ||
+ | Proj1 proj1 = {}, Proj2 proj2 = {} ); | ||
}} | }} | ||
{{dcl end}} | {{dcl end}} | ||
@1@ Search-based algorithm that checks whether or not a given range contains a value with iterator-sentinel pairs. | @1@ Search-based algorithm that checks whether or not a given range contains a value with iterator-sentinel pairs. | ||
− | @2@ Same as {{v|1}} but | + | @2@ Same as {{v|1}} but uses {{c|r}} as the source range, as if using {{c|ranges::begin(r)}} as {{c|first}} and {{c|ranges::end(r)}} as {{c|last}}. |
@3@ Search-based algorithm that checks whether or not a given range is a subrange of another range with iterator-sentinel pairs. | @3@ Search-based algorithm that checks whether or not a given range is a subrange of another range with iterator-sentinel pairs. | ||
− | @4@ Same as {{v|3}} but | + | @4@ Same as {{v|3}} 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}} | |
− | + | ===Parameters=== | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | === Parameters === | + | |
{{par begin}} | {{par begin}} | ||
− | {{par | first, last | the range of elements to examine}} | + | {{par|first, last|the range of elements to examine}} |
− | {{par | r | the range of the elements to examine}} | + | {{par|r|the range of the elements to examine}} |
− | {{par | value | value to compare the elements to}} | + | {{par|value|value to compare the elements to}} |
− | {{par | pred | predicate to apply to the projected elements}} | + | {{par|pred|predicate to apply to the projected elements}} |
− | {{par | proj | projection to apply to the elements}} | + | {{par|proj|projection to apply to the elements}} |
{{par end}} | {{par end}} | ||
− | === Return value === | + | ===Return value=== |
− | + | @1,2@: {{c|1=ranges::find(std::move(first), last, value, proj) != last}} | |
− | + | ||
− | === | + | @3,4@: {{c|1=first2 == last2 {{!!}} !ranges::search(first1, last1, first2, last2, pred, proj1, proj2).empty()}} |
− | + | ||
− | === See also === | + | ===Complexity=== |
+ | At most {{c|last - first}} applications of the predicate and projection. | ||
+ | |||
+ | ===Notes=== | ||
+ | Up until C++20, we've had to write {{c|1= std::ranges::find(r, value) != std::ranges::end(r)}} to determine if a single value is inside a range. And to check if a range contains a subrange of interest, we use {{c|1= not std::ranges::search(haystack, needle).empty()}}. While this is accurate, it isn't necessarily convenient, and it hardly expresses intent (especially in the latter case). Being able to say {{c|std::ranges::contains(r, value)}} addresses both of these points. | ||
+ | |||
+ | {{tt|ranges::contains_subrange}}, same as {{lc|ranges::search}}, but as opposed to {{lc|std::search}}, provides no access to {{named req|Searcher}}s (such as [[cpp/utility/functional#Searchers|Boyer-Moore]]). | ||
+ | |||
+ | {{ftm begin}} | ||
+ | {{ftm|__cpp_lib_ranges_contains|value=202207L|std=C++23|{{ttt|std::ranges::contains}} and {{ttt|ranges::contains_subrange}}}} | ||
+ | {{ftm|__cpp_lib_algorithm_default_value_type|value=202403|std=C++26|[[cpp/language/list initialization|List-initialization]] for algorithms {{vl|1,2}}}} | ||
+ | {{ftm end}} | ||
+ | |||
+ | ===Possible implementation=== | ||
+ | {{eq impl | ||
+ | |title1=contains (1,2)|ver1=1|1= | ||
+ | struct __contains_fn | ||
+ | { | ||
+ | template<std::input_iterator I, std::sentinel_for<I> S, | ||
+ | class Proj = std::identity, | ||
+ | class T = std::projected_value_t<I, Proj>> | ||
+ | requires std::indirect_binary_predicate<ranges::equal_to, std::projected<I, Proj>, | ||
+ | const T*> | ||
+ | constexpr bool operator()(I first, S last, const T& value, Proj proj = {}) const | ||
+ | { | ||
+ | return ranges::find(std::move(first), last, value, proj) != last; | ||
+ | } | ||
+ | |||
+ | template<ranges::input_range R, | ||
+ | class Proj = std::identity, | ||
+ | class T = std::projected_value_t<ranges::iterator_t<R>, Proj>> | ||
+ | requires std::indirect_binary_predicate<ranges::equal_to, | ||
+ | std::projected<ranges::iterator_t<R>, Proj>, | ||
+ | const T*> | ||
+ | constexpr bool operator()(R&& r, const T& value, Proj proj = {}) const | ||
+ | { | ||
+ | return (*this)(ranges::begin(r), ranges::end(r), std::move(value), proj); | ||
+ | } | ||
+ | }; | ||
+ | |||
+ | inline constexpr __contains_fn contains {}; | ||
+ | |title2=contains_subrange (3,4)|ver2=3|2= | ||
+ | struct __contains_subrange_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 bool operator()(I1 first1, S1 last1, | ||
+ | I2 first2, S2 last2, | ||
+ | Pred pred = {}, | ||
+ | Proj1 proj1 = {}, Proj2 proj2 = {}) const | ||
+ | { | ||
+ | return (first2 == last2) {{!!}} | ||
+ | !ranges::search(first1, last1, first2, last2, pred, proj1, proj2).empty(); | ||
+ | } | ||
+ | |||
+ | 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 bool 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 __contains_subrange_fn contains_subrange {}; | ||
+ | }} | ||
+ | |||
+ | ===Example=== | ||
+ | {{example | ||
+ | |code= | ||
+ | #include <algorithm> | ||
+ | #include <array> | ||
+ | #include <complex> | ||
+ | |||
+ | namespace ranges = std::ranges; | ||
+ | |||
+ | int main() | ||
+ | { | ||
+ | constexpr auto haystack = std::array{3, 1, 4, 1, 5}; | ||
+ | constexpr auto needle = std::array{1, 4, 1}; | ||
+ | constexpr auto bodkin = std::array{2, 5, 2}; | ||
+ | |||
+ | static_assert( | ||
+ | ranges::contains(haystack, 4) && | ||
+ | !ranges::contains(haystack, 6) && | ||
+ | ranges::contains_subrange(haystack, needle) && | ||
+ | !ranges::contains_subrange(haystack, bodkin) | ||
+ | ); | ||
+ | |||
+ | constexpr std::array<std::complex<double>, 3> nums{<!---->{<!---->{1, 2}, {3, 4}, {5, 6}<!---->}<!---->}; | ||
+ | #ifdef __cpp_lib_algorithm_default_value_type | ||
+ | static_assert(ranges::contains(nums, {3, 4})); | ||
+ | #else | ||
+ | static_assert(ranges::contains(nums, std::complex<double>{3, 4})); | ||
+ | #endif | ||
+ | } | ||
+ | }} | ||
+ | |||
+ | ===See also=== | ||
{{dsc begin}} | {{dsc begin}} | ||
− | {{dsc inc | cpp/algorithm/ranges/dsc find}} | + | {{dsc inc|cpp/algorithm/ranges/dsc find}} |
− | {{dsc inc | cpp/algorithm/ranges/dsc search}} | + | {{dsc inc|cpp/algorithm/ranges/dsc search}} |
+ | {{dsc inc|cpp/algorithm/ranges/dsc binary_search}} | ||
+ | {{dsc inc|cpp/algorithm/ranges/dsc includes}} | ||
+ | {{dsc inc|cpp/algorithm/ranges/dsc all_any_none_of}} | ||
{{dsc end}} | {{dsc end}} | ||
+ | |||
+ | {{langlinks|de|es|fr|it|ja|pt|ru|zh}} |
Latest revision as of 22:44, 20 May 2024
Defined in header <algorithm>
|
||
Call signature |
||
(1) | ||
template< std::input_iterator I, std::sentinel_for<I> S, class T, |
(since C++23) (until C++26) |
|
template< std::input_iterator I, std::sentinel_for<I> S, class Proj = std::identity, |
(since C++26) | |
(2) | ||
template< ranges::input_range R, class T, |
(since C++23) (until C++26) |
|
template< ranges::input_range R, class Proj = std::identity, |
(since C++26) | |
template< std::forward_iterator I1, std::sentinel_for<I1> S1, std::forward_iterator I2, std::sentinel_for<I2> S2, |
(3) | (since C++23) |
template< ranges::forward_range R1, ranges::forward_range R2, class Pred = ranges::equal_to, |
(4) | (since C++23) |
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.
Contents |
[edit] Parameters
first, last | - | the range of elements to examine |
r | - | the range of the elements to examine |
value | - | value to compare the elements to |
pred | - | predicate to apply to the projected elements |
proj | - | projection to apply to the elements |
[edit] Return value
[edit] Complexity
At most last - first applications of the predicate and projection.
[edit] Notes
Up until C++20, we've had to write std::ranges::find(r, value) != std::ranges::end(r) to determine if a single value is inside a range. And to check if a range contains a subrange of interest, we use not std::ranges::search(haystack, needle).empty(). While this is accurate, it isn't necessarily convenient, and it hardly expresses intent (especially in the latter case). Being able to say std::ranges::contains(r, value) addresses both of these points.
ranges::contains_subrange
, same as ranges::search, but as opposed to std::search, provides no access to Searchers (such as Boyer-Moore).
Feature-test macro | Value | Std | Feature |
---|---|---|---|
__cpp_lib_ranges_contains |
202207L | (C++23) | std::ranges::contains and ranges::contains_subrange
|
__cpp_lib_algorithm_default_value_type |
202403 | (C++26) | List-initialization for algorithms (1,2) |
[edit] Possible implementation
contains (1,2) |
---|
struct __contains_fn { template<std::input_iterator I, std::sentinel_for<I> S, class Proj = std::identity, class T = std::projected_value_t<I, Proj>> requires std::indirect_binary_predicate<ranges::equal_to, std::projected<I, Proj>, const T*> constexpr bool operator()(I first, S last, const T& value, Proj proj = {}) const { return ranges::find(std::move(first), last, value, proj) != last; } template<ranges::input_range R, class Proj = std::identity, class T = std::projected_value_t<ranges::iterator_t<R>, Proj>> requires std::indirect_binary_predicate<ranges::equal_to, std::projected<ranges::iterator_t<R>, Proj>, const T*> constexpr bool operator()(R&& r, const T& value, Proj proj = {}) const { return (*this)(ranges::begin(r), ranges::end(r), std::move(value), proj); } }; inline constexpr __contains_fn contains {}; |
contains_subrange (3,4) |
struct __contains_subrange_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 bool operator()(I1 first1, S1 last1, I2 first2, S2 last2, Pred pred = {}, Proj1 proj1 = {}, Proj2 proj2 = {}) const { return (first2 == last2) || !ranges::search(first1, last1, first2, last2, pred, proj1, proj2).empty(); } 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 bool 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 __contains_subrange_fn contains_subrange {}; |
[edit] Example
#include <algorithm> #include <array> #include <complex> namespace ranges = std::ranges; int main() { constexpr auto haystack = std::array{3, 1, 4, 1, 5}; constexpr auto needle = std::array{1, 4, 1}; constexpr auto bodkin = std::array{2, 5, 2}; static_assert( ranges::contains(haystack, 4) && !ranges::contains(haystack, 6) && ranges::contains_subrange(haystack, needle) && !ranges::contains_subrange(haystack, bodkin) ); constexpr std::array<std::complex<double>, 3> nums{{{1, 2}, {3, 4}, {5, 6}}}; #ifdef __cpp_lib_algorithm_default_value_type static_assert(ranges::contains(nums, {3, 4})); #else static_assert(ranges::contains(nums, std::complex<double>{3, 4})); #endif }
[edit] See also
(C++20)(C++20)(C++20) |
finds the first element satisfying specific criteria (niebloid) |
(C++20) |
searches for the first occurrence of a range of elements (niebloid) |
(C++20) |
determines if an element exists in a partially-ordered range (niebloid) |
(C++20) |
returns true if one sequence is a subsequence of another (niebloid) |
(C++20)(C++20)(C++20) |
checks if a predicate is true for all, any or none of the elements in a range (niebloid) |