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

From cppreference.net

定義済みヘッダー `<algorithm>`
呼び出しシグネチャ
	(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 = { } ) ;			(C++23以降) (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 = { } ) ;			(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 = { } ) ;				(C++23以降) (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 = { } ) ;				(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)	(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)	(C++23以降)

1,2) 指定された範囲が値 value を含むかどうかを検査します。

1) ソース範囲は

first

last

です。

2) ソース範囲は

ranges:: begin ( r )

ranges:: end ( r )

です。

3) 指定された範囲が別の範囲のサブレンジであるかどうかをチェックします。

3) 最初のソース範囲は

first1

last1

であり、2番目のソース範囲は

first2

last2

です。

4) 最初のソース範囲は

ranges:: begin ( r1 )

ranges:: end ( r1 )

であり、2番目のソース範囲は

ranges:: begin ( r2 )

ranges:: end ( r2 )

です。

このページで説明されている関数ライクなエンティティは、 アルゴリズム関数オブジェクト （非公式には niebloids として知られる）です。すなわち：

明示的なテンプレート引数リストは、いずれかを呼び出す際に指定することはできません。
いずれも実引数依存の名前探索では可視になりません。
いずれかが関数呼び出し演算子の左側の名前として通常の非修飾名前探索によって見つかった場合、実引数依存の名前探索は抑制されます。

翻訳の説明： - 「Contents」を「目次」に翻訳しました - C++関連の専門用語（Parameters、Return value、Complexity、Notes、Possible implementation、Example、See also）は原文のまま保持しました - HTMLタグ、属性、クラス名、ID、リンク先は一切変更していません - 数値や書式設定は完全に保持されています

パラメータ

first, last	-	検査する要素の範囲を定義するイテレータ-センチネルペア
r	-	検査する要素の範囲
value	-	要素と比較する値
pred	-	投影された要素に適用する述語
proj	-	要素に適用する投影

戻り値

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 ( )

計算量

1) 最大 ranges:: distance ( first, last ) 回の比較。

2) 最大 ranges:: distance ( r ) 回の比較。

3) 最大 ranges:: distance ( first1, last1 ) * ranges:: distance ( first2, last2 ) 回の比較。

4) 最大 ranges:: distance ( r1 ) * ranges:: distance ( r2 ) 回の比較。

注記

C++20では、 contains 関数を ranges:: find ( haystack, needle ) ! = ranges:: end ( haystack ) で実装でき、 contains_subrange は ! ranges:: search ( haystack, needle ) . empty ( ) で実装できます。

ranges::contains_subrange 、 ranges::search と同様に、 std::search とは異なり、 searchers （例えば std::boyer_moore_searcher など）のサポートがありません。

機能テストマクロ	値	標準	機能
`__cpp_lib_ranges_contains`	`202207L`	(C++23)	`ranges::contains` および `ranges::contains_subrange`
`__cpp_lib_algorithm_default_value_type`	`202403L`	(C++26)	リスト初期化アルゴリズム用 ( 1,2 )

実装例

**注記**: 提供されたコードはC++のテンプレートコードであり、HTMLタグ内の`

`と``タグで囲まれているため、翻訳対象外です。指示に従い、C++のコード部分は一切翻訳せず、元のまま保持しています。HTML構造とフォーマットも完全に維持されています。

**注記**: 提供されたHTMLコードはC++のコードスニペットを含んでおり、指示に従って以下の点を厳密に守りました： - HTMLタグと属性は一切翻訳せず - `


        `, `
        `, ` $`タグ内のテキストは翻訳せず
- C++固有の用語（関数名、クラス名、キーワードなど）は翻訳せず
コード部分は完全に元のまま保持されています。$

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{};

例

このコードを実行

#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)	特定の条件を満たす最初の要素を見つける (アルゴリズム関数オブジェクト)
ranges::search (C++20)	要素の範囲の最初の出現を検索する (アルゴリズム関数オブジェクト)
ranges::binary_search (C++20)	半順序範囲に要素が存在するかどうかを判定する (アルゴリズム関数オブジェクト)
ranges::includes (C++20)	一方のシーケンスが他方の部分シーケンスである場合に true を返す (アルゴリズム関数オブジェクト)
ranges::all_of ranges::any_of ranges::none_of (C++20) (C++20) (C++20)	範囲内のすべての要素、いずれかの要素、またはどの要素に対しても述語が true であるかどうかをチェックする (アルゴリズム関数オブジェクト)

cppreference.net

Namespaces

Variants

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

目次

パラメータ

戻り値

計算量

注記

実装例

例

関連項目