std:: includes
|
ヘッダー
<algorithm>
で定義
|
||
|
template
<
class
InputIt1,
class
InputIt2
>
bool
includes
(
InputIt1 first1, InputIt1 last1,
|
(1) | (constexpr since C++20) |
|
template
<
class
ExecutionPolicy,
class
ForwardIt1,
class
ForwardIt2
>
|
(2) | (since C++17) |
|
template
<
class
InputIt1,
class
InputIt2,
class
Compare
>
bool
includes
(
InputIt1 first1, InputIt1 last1,
|
(3) | (constexpr since C++20) |
|
template
<
class
ExecutionPolicy,
class
ForwardIt1,
class
ForwardIt2,
class
Compare
>
|
(4) | (since C++17) |
ソート済み範囲
[
first2
,
last2
)
がソート済み範囲
[
first1
,
last1
)
の
部分列
である場合(部分列は連続している必要はありません)、
true
を返します。
[
first1
,
last1
)
または
[
first2
,
last2
)
が
ソート済み
でない場合
operator
<
(C++20以前)
std::
less
{
}
(C++20以降)
に関して、動作は未定義です。
,
last1
)
または
[
first2
,
last2
)
が
comp
に関してソートされていない場合、動作は未定義です。
|
std:: is_execution_policy_v < std:: decay_t < ExecutionPolicy >> が true であること。 |
(C++20まで) |
|
std:: is_execution_policy_v < std:: remove_cvref_t < ExecutionPolicy >> が true であること。 |
(C++20以降) |
目次 |
パラメータ
| first1, last1 | - | 検索対象のソート済み要素範囲を定義するイテレータのペア |
| first2, last2 | - | 検索する要素のソート済み範囲を定義するイテレータのペア |
| policy | - | 使用する実行ポリシー |
| comp | - |
比較関数オブジェクト(つまり、
Compare
の要件を満たすオブジェクト)。最初の引数が2番目の引数より
小さい
(つまり、順序が
前
にある)場合に
true
を返す。
比較関数のシグネチャは以下と同等であるべき: bool cmp ( const Type1 & a, const Type2 & b ) ;
シグネチャが
const
&
を持つ必要はないが、関数は渡されたオブジェクトを変更してはならず、
値カテゴリ
に関係なく(したがって、
|
| 型要件 | ||
-
InputIt1, InputIt2
は
LegacyInputIterator
の要件を満たさなければならない。
|
||
-
ForwardIt1, ForwardIt2
は
LegacyForwardIterator
の要件を満たさなければならない。
|
||
-
Compare
は
Compare
の要件を満たさなければならない。
|
||
戻り値
true
が
[
first2
,
last2
)
が
[
first1
,
last1
)
の部分列である場合、そうでなければ
false
を返す。
空のシーケンスはあらゆるシーケンスの部分シーケンスであるため、
true
が返されるのは
[
first2
,
last2
)
が空の場合です。
計算量
N 1 を std:: distance ( first1, last1 ) として、 N 2 を std:: distance ( first2, last2 ) として定義する:
例外
ExecutionPolicy
という名前のテンプレートパラメータを持つオーバーロードは、
以下のようにエラーを報告します:
-
アルゴリズムの一部として呼び出された関数の実行が例外をスローした場合、
ExecutionPolicyが 標準ポリシー のいずれかであるとき、 std::terminate が呼び出される。それ以外のExecutionPolicyについては、動作は実装定義である。 - アルゴリズムがメモリの確保に失敗した場合、 std::bad_alloc がスローされる。
実装例
| インクルード (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; } |
| インクルード (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 を返す |
関連項目
|
2つの集合の差を計算する
(関数テンプレート) |
|
|
要素の範囲の最初の出現を検索する
(関数テンプレート) |
|
|
(C++20)
|
1つのシーケンスが別のシーケンスの部分シーケンスである場合に
true
を返す
(アルゴリズム関数オブジェクト) |