std::ranges:: contains, std::ranges:: contains_subrange

From cppreference.net

Defined in header `<algorithm>`
Call signature
	(1)
template < std:: input_iterator I, std:: sentinel_for < I > S, class T, 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 = { } ) ;			(since C++23) (until C++26)
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 = { } ) ;			(since C++26)
		(2)
template < ranges:: input_range R, class T, 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 = { } ) ;				(since C++23) (until C++26)
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 = { } ) ;				(since C++26)
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 contains_subrange ( I1 first1, S1 last1, I2 first2, S2 last2, Pred pred = { } , Proj1 proj1 = { } , Proj2 proj2 = { } ) ;			(3)	(since C++23)
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 contains_subrange ( R1 && r1, R2 && r2, Pred pred = { } , Proj1 proj1 = { } , Proj2 proj2 = { } ) ;			(4)	(since C++23)

1,2) Checks whether or not a given range contains the value value .

1) The source range is

first

last

2) The source range is

ranges:: begin ( r )

ranges:: end ( r )

3) Checks whether or not a given range is a subrange of another range.

3) The first source range is

first1

last1

, and the second source range is

first2

last2

4) The first source range is

ranges:: begin ( r1 )

ranges:: end ( r1 )

, and the second source range is

ranges:: begin ( r2 )

ranges:: end ( r2 )

The function-like entities described on this page are algorithm function objects (informally known as 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.

Parameters

first, last	-	the iterator-sentinel pair defining 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

Return value

1) ranges:: find ( std :: move ( first ) , last, value, proj ) ! = last

2) ranges:: find ( std :: move ( ranges:: begin ( r ) ) , ranges:: end ( r ) , value, proj ) ! = ranges:: end ( r )

3) first2 == last2 || ! ranges:: search ( first1, last1, first2, last2, pred, proj1, proj2 ) . empty ( )

4) ranges:: begin ( r2 ) == ranges:: end ( r2 ) ||
! ranges:: search ( ranges:: begin ( r1 ) , ranges:: end ( r1 ) ,
ranges:: begin ( r2 ) , ranges:: end ( r2 ) , pred, proj1, proj2 ) . empty ( )

Complexity

1) At most ranges:: distance ( first, last ) comparisons.

2) At most ranges:: distance ( r ) comparisons.

3) At most ranges:: distance ( first1, last1 ) * ranges:: distance ( first2, last2 ) comparisons.

4) At most ranges:: distance ( r1 ) * ranges:: distance ( r2 ) comparisons.

Notes

In C++20, one may implement a contains function with ranges:: find ( haystack, needle ) ! = ranges:: end ( haystack ) or contains_subrange with ! ranges:: search ( haystack, needle ) . empty ( ) .

ranges::contains_subrange , like ranges::search , and unlike std::search , has no support for searchers (such as std::boyer_moore_searcher ).

Feature-test macro	Value	Std	Feature
`__cpp_lib_ranges_contains`	`202207L`	(C++23)	`ranges::contains` and `ranges::contains_subrange`
`__cpp_lib_algorithm_default_value_type`	`202403L`	(C++26)	List-initialization for algorithms ( 1,2 )

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 ranges::find(std::move(ranges::begin(r)),
                            ranges::end(r), value, proj) != ranges::end(r);
    }
};
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 (first2 == last2) ||
                   !ranges::search(ranges::begin(r1), ranges::end(r1),
                                   ranges::begin(r2), ranges::end(r2),
                                   pred, proj1, proj2).empty();
    }
};
inline constexpr __contains_subrange_fn contains_subrange{};

Example

Run this 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
}

Compiler support
Freestanding and hosted
Language
Standard library
Standard library headers
Named requirements
Feature test macros (C++20)
Language support library
Concepts library (C++20)
Diagnostics library
Memory management library
Metaprogramming library (C++11)
General utilities library
Containers library
Iterators library
Ranges library (C++20)
Algorithms library
Strings library
Text processing library
Numerics library
Date and time library
Input/output library
Filesystem library (C++17)
Concurrency support library (C++11)
Execution control library (C++26)
Technical specifications
Symbols index
External libraries

ranges::find ranges::find_if ranges::find_if_not (C++20) (C++20) (C++20)	finds the first element satisfying specific criteria (algorithm function object)
ranges::search (C++20)	searches for the first occurrence of a range of elements (algorithm function object)
ranges::binary_search (C++20)	determines if an element exists in a partially-ordered range (algorithm function object)
ranges::includes (C++20)	returns true if one sequence is a subsequence of another (algorithm function object)
ranges::all_of ranges::any_of ranges::none_of (C++20) (C++20) (C++20)	checks if a predicate is true for all, any or none of the elements in a range (algorithm function object)

cppreference.net

Namespaces

Variants