std::includes

ヘッダ `<algorithm>`
template< class InputIt1, class InputIt2 > bool includes( InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2 );	で定義 (1)	(C++20 から constexpr)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2 > bool includes( ExecutionPolicy&& policy, ForwardIt1 first1, ForwardIt1 last1, ForwardIt2 first2, ForwardIt2 last2 );	(2)	(C++17 から)
template< class InputIt1, class InputIt2, class Compare > bool includes( InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, Compare comp );	(3)	(C++20 から constexpr)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2, class Compare > bool includes( ExecutionPolicy&& policy, ForwardIt1 first1, ForwardIt1 last1, ForwardIt2 first2, ForwardIt2 last2, Compare comp );	(4)	(C++17 から)

true は、ソート済み範囲 [first2, last2) が部分列としてソート済み範囲 [first1, last1) に含まれる場合に返される（部分列は連続している必要はない）。

1) [first1, last1) または [first2, last2) がソートされておらず、operator<(C++20 まで)std::less{}(C++20 から)に関して動作は未定義です。

3) [first1, last1) または [first2, last2) が comp に関してソートされていない場合、動作は未定義です。

2,4) (1,3) と同じですが、に従って実行されます。policy.

これらのオーバーロードは、次の式の値が true である場合にのみオーバーロード解決に参加します。

`std::is_execution_policy_v<std::decay_t<ExecutionPolicy>>`	(C++20 まで)
`std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>>`	(C++20 から)

引数

first1, last1	-	調査するソート済み範囲の要素を定義するイテレータの組
first2, last2	-	検索するソート済み範囲の要素を定義するイテレータの組
policy	-	使用する実行ポリシー
comp	-	比較関数オブジェクト（Compare の要件を満たすオブジェクト）。`true` を返します。ただし、最初の引数が2番目より小さい（すなわち、前に順序付けられる）場合に限ります。比較関数のシグネチャは以下と同等である必要があります。 `bool cmp(const Type1& a, const Type2& b);` シグネチャに `const&` を含める必要はありませんが、関数は渡されたオブジェクトを変更してはならず、型（const の可能性がある）`Type1` および `Type2` のすべての値を値カテゴリに関係なく受け入れられなければなりません（したがって、`Type1&` は許可されません。また、`Type1` は、`Type1` ムーブがコピーと同等である場合を除き許可されません(C++11 から)）。型 `Type1` および `Type2` は、`InputIt` 型のオブジェクトを逆参照して、暗黙的に両方に変換できるようにする必要があります。
型要件
- `InputIt1, InputIt2` は LegacyInputIterator の要件を満たす必要があります。
- `ForwardIt1, ForwardIt2` は LegacyForwardIterator の要件を満たす必要があります。
- `Compare` は Compare の要件を満たす必要があります。

戻り値

true [first2, last2) が [first1, last1) の部分列である場合は false。

空のシーケンスは任意のシーケンスの部分列であるため、true が返されます（[first2, last2) が空の場合）。

計算量

$\scriptsize N_1$ $N 1$ を std::distance(first1, last1) 、$\scriptsize N_2$ $N 2$ を std::distance(first2, last2) とすると:

1,2) 最大

2\cdot(N 1 +N 2)-1

回の比較 (operator<(C++20 まで)std::less{}(C++20 から) を使用)。

3,4) 最大

2\cdot(N 1 +N 2)-1

回の比較関数 comp の適用。

例外

テンプレートパラメータ ExecutionPolicy を持つオーバーロードは、次のようにエラーを報告します:

アルゴリズムの一部として呼び出された関数が例外をスローし、ExecutionPolicy が標準ポリシーの1つである場合、std::terminate が呼び出されます。それ以外の ExecutionPolicy の場合、動作は処理系定義です。
メモリの確保に失敗した場合、std::bad_alloc がスローされます。

実装の可能性

include (1)

template<class InputIt1, class InputIt2>
bool includes(InputIt1 first1, InputIt1 last1,
              InputIt2 first2, InputIt2 last2)
{
    for (; first2 != last2; ++first1)
    {
        if (first1 == last1 || *first2 < *first1)
            return false;
        if (!(*first1 < *first2))
            ++first2;
    }
    return true;
}

include (3)

template<class InputIt1, class InputIt2, class Compare>
bool includes(InputIt1 first1, InputIt1 last1,
              InputIt2 first2, InputIt2 last2, Compare comp)
{
    for (; first2 != last2; ++first1)
    {
        if (first1 == last1 || comp(*first2, *first1))
            return false;
        if (!comp(*first1, *first2))
            ++first2;
    }
    return true;
}

例

このコードを実行する

#include <algorithm>
#include <cctype>
#include <iostream>

template<class Os, class Co>
Os& operator<<(Os& os, const Co& v)
{
    for (const auto& i : v)
        os << i << ' ';
    return os << '\t';
}

int main()
{
    const auto
        v1 = {'a', 'b', 'c', 'f', 'h', 'x'},
        v2 = {'a', 'b', 'c'},
        v3 = {'a', 'c'},
        v4 = {'a', 'a', 'b'},
        v5 = {'g'},
        v6 = {'a', 'c', 'g'},
        v7 = {'A', 'B', 'C'};

    auto no_case = [](char a, char b) { return std::tolower(a) < std::tolower(b); };

    std::cout
    << v1 << "\nincludes:\n" << std::boolalpha
    << v2 << ": " << std::includes(v1.begin(), v1.end(), v2.begin(), v2.end()) << '\n'
    << v3 << ": " << std::includes(v1.begin(), v1.end(), v3.begin(), v3.end()) << '\n'
    << v4 << ": " << std::includes(v1.begin(), v1.end(), v4.begin(), v4.end()) << '\n'
    << v5 << ": " << std::includes(v1.begin(), v1.end(), v5.begin(), v5.end()) << '\n'
    << v6 << ": " << std::includes(v1.begin(), v1.end(), v6.begin(), v6.end()) << '\n'
    << v7 << ": " << std::includes(v1.begin(), v1.end(), v7.begin(), v7.end(), no_case)
          << " (case-insensitive)\n";
}

出力:

a b c f h x
includes:
a b c   : true
a c     : true
a a b   : false
g       : false
a c g   : false
A B C   : true (case-insensitive)

欠陥報告

以下の動作変更欠陥報告は、以前に公開された C++ 標準に遡って適用されました。

DR	適用先	公開された動作	正しい動作
LWG 1205	C++98	`[first2,` `last2)` が空の場合の戻り値が不明確でした	この場合は `true` を返す

コンパイラサポート
フリースタンディングとホステッド
言語
標準ライブラリ
標準ライブラリヘッダ
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
一般ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
レンジライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時間ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行処理サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
技術仕様書
シンボルインデックス
外部ライブラリ

set_difference	2つの集合の差を計算します (関数テンプレート & アルゴリズム関数オブジェクト)
ranges::set_difference (C++20)	2つの集合の差を計算します (関数テンプレート & アルゴリズム関数オブジェクト)
search	要素範囲の最初の出現を検索します (関数テンプレート & アルゴリズム関数オブジェクト)
ranges::search (C++20)	要素範囲の最初の出現を検索します (関数テンプレート & アルゴリズム関数オブジェクト)
ranges::includes (C++20)	一方のシーケンスが他方の部分列であるかどうかを判定します (アルゴリズム関数オブジェクト)

ja.cppreference.net

Namespaces

Variants

std::includes

目次

引数

戻り値

計算量

例外

実装の可能性

例

欠陥報告

関連項目