std::equal

 

C++

言語

ヘッダ

コンセプト

言語サポートライブラリ

診断ライブラリ

ユーティリティライブラリ

文字列ライブラリ

コンテナライブラリ

アルゴリズムライブラリ

イテレータライブラリ

数値演算ライブラリ

入出力ライブラリ

ローカライゼーションライブラリ

正規表現ライブラリ(C++11)

アトミック操作ライブラリ(C++11)

スレッドサポートライブラリ(C++11)

ファイルシステムライブラリ(C++17)

技術仕様書

 

アルゴリズムライブラリ

実行ポリシー (C++17)
is_execution_policy	execution::seqexecution::parexecution::par_unseq	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policy
非変更シーケンス操作
all_ofany_ofnone_of (C++11)(C++11)(C++11) for_each for_each_n (C++17)	countcount_if mismatch equal adjacent_find	findfind_iffind_if_not (C++11) find_end find_first_of	search search_n lexicographical_compare lexicographical_compare_3way (C++20)
変更シーケンス操作
copycopy_if (C++11) copy_n (C++11) copy_backward move (C++11) move_backward (C++11) transform	fill fill_n generate generate_n swap iter_swap swap_ranges sample (C++17)	removeremove_if replacereplace_if reverse rotate unique random_shuffle (C++17以前)	remove_copyremove_copy_if replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy shuffle (C++11)
未初期化記憶域の操作
uninitialized_copy uninitialized_move (C++17)	uninitialized_copy_n (C++11) uninitialized_move_n (C++17)	uninitialized_fill	uninitialized_fill_n
分割操作
is_partitioned (C++11) partition_point (C++11)	partition partition_copy (C++11)	stable_partition
ソート操作
is_sorted (C++11) is_sorted_until (C++11)	sort stable_sort	partial_sort partial_sort_copy	nth_element
バイナリサーチ操作
lower_bound	upper_bound	binary_search	equal_range
集合操作 (ソート済み範囲用)
merge inplace_merge	set_difference set_intersection	set_symmetric_difference set_union	includes
ヒープ操作
is_heap (C++11) is_heap_until (C++11)	make_heap sort_heap	push_heap pop_heap
最小/最大演算
max max_element	min min_element	minmax (C++11) minmax_element (C++11)	clamp (C++17) compare_3way (C++20)
順列
is_permutation (C++11)	next_permutation	prev_permutation
数値演算
iota (C++11) inner_product adjacent_difference	accumulate reduce (C++17) transform_reduce (C++17)	partial_sum inclusive_scan (C++17) exclusive_scan (C++17)	transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)
C のライブラリ
qsort	bsearch

 

ヘッダ <algorithm> で定義
	(1)
template<class InputIt1, class InputIt2 > bool equal( InputIt1 first1, InputIt1 last1,             InputIt2 first2 );			(C++20以前)
template<class InputIt1, class InputIt2 > constexprbool equal( InputIt1 first1, InputIt1 last1,                       InputIt2 first2 );			(C++20およびそれ以降)
template<class ExecutionPolicy, class ForwardIt1, class ForwardIt2 > bool equal( ExecutionPolicy&& policy, ForwardIt1 first1, ForwardIt1 last1,             ForwardIt2 first2 );		(2)	(C++17およびそれ以降)
		(3)
template<class InputIt1, class InputIt2, class BinaryPredicate > bool equal( InputIt1 first1, InputIt1 last1,             InputIt2 first2, BinaryPredicate p );				(C++20以前)
template<class InputIt1, class InputIt2, class BinaryPredicate > constexprbool equal( InputIt1 first1, InputIt1 last1,                       InputIt2 first2, BinaryPredicate p );				(C++20およびそれ以降)
template<class ExecutionPolicy, class ForwardIt1, class ForwardIt2, class BinaryPredicate > bool equal( ExecutionPolicy&& policy, ForwardIt1 first1, ForwardIt1 last1,             ForwardIt2 first2, BinaryPredicate p );			(4)	(C++17およびそれ以降)
			(5)
template<class InputIt1, class InputIt2 > bool equal( InputIt1 first1, InputIt1 last1,             InputIt2 first2, InputIt2 last2 );					(C++14およびそれ以降) (C++20以前)
template<class InputIt1, class InputIt2 > constexprbool equal( InputIt1 first1, InputIt1 last1,                       InputIt2 first2, InputIt2 last2 );					(C++20およびそれ以降)
template<class ExecutionPolicy, class ForwardIt1, class ForwardIt2 > bool equal( ExecutionPolicy&& policy, ForwardIt1 first1, ForwardIt1 last1,             ForwardIt2 first2, ForwardIt2 last2 );				(6)	(C++17およびそれ以降)
				(7)
template<class InputIt1, class InputIt2, class BinaryPredicate > bool equal( InputIt1 first1, InputIt1 last1,             InputIt2 first2, InputIt2 last2,             BinaryPredicate p );						(C++14およびそれ以降) (C++20以前)
template<class InputIt1, class InputIt2, class BinaryPredicate > constexprbool equal( InputIt1 first1, InputIt1 last1,                       InputIt2 first2, InputIt2 last2,                       BinaryPredicate p );						(C++20およびそれ以降)
template<class ExecutionPolicy, class ForwardIt1, class ForwardIt2, class BinaryPredicate > bool equal( ExecutionPolicy&& policy, ForwardIt1 first1, ForwardIt1 last1,             ForwardIt2 first2, ForwardIt2 last2,             BinaryPredicate p );					(8)	(C++17およびそれ以降)

1,3) 範囲 [first1, last1) が範囲 [first2, first2 + (last1 - first1)) と等しければ true、そうでなければ false を返します。

5,7) 範囲 [first1, last1) が範囲 [first2, last2) と等しければ true、そうでなければ false を返します。

2,4,6,8)(1,3,5,7) と同じですが、 policy に従って実行されます。 このオーバーロードは、 std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> が true である場合にのみ、オーバーロード解決に参加します。

2つの範囲が同じ個数の要素を持ち、範囲 [first1,last1) 内のすべてのイテレータ i について *i が *(first2 +(i - first1)) と等しければ、2つの範囲は等しいとみなされます。 オーバーロード (1,2,5,6) は2つの要素が等しいかどうかを判定するために operator== を使用し、オーバーロード (3,4,7,8) は指定された二項述語を使用します。

引数

first1, last1	-	1つめの比較する要素の範囲
first2, last2	-	2つめの比較する要素の範囲
policy	-	使用する実行ポリシー。 詳細は実行ポリシーを参照してください
p	-	要素が等しいと扱われるべき場合に ​true を返す二項述語。 述語関数のシグネチャは以下と同等なものであるべきです。  bool pred(const Type1 &a, const Type2 &b); シグネチャが const& を持つ必要はありませんが、関数は渡されたオブジェクトを変更してはなりません。 型 Type1 および Type2 は、 InputIt1 および InputIt2 型のオブジェクトの逆参照からType1 および Type2 にそれぞれ暗黙に変換可能なものでなければなりません。 ​
型の要件
- InputIt1, InputIt2 は InputIterator の要件を満たさなければなりません。
- ForwardIt1, ForwardIt2 は ForwardIterator の要件を満たさなければなりません。

戻り値

5-8) 範囲 [first1, last1) の長さが範囲 [first2, last2) の長さと等しくなければ false を返します。

2つの範囲の要素が等しければ true を返します。

そうでなければ false を返します。

ノート

std::equal は、 std::unordered_set、 std::unordered_multiset、 std::unordered_map または std::unordered_multimap のイテレータによって形成された範囲を比較するためには、使用するべきではありません。 これらのコンテナは、2つのコンテナが同じ要素を格納していても、その要素が格納されている順序は異なる可能性があるためです。

コンテナ全体の等しさを比較するときは、通常、対応するコンテナの operator== が推奨されます。

計算量

1,3) 多くとも last1 - first1 回の述語の適用。

5,7) 多くとも min(last1 - first1, last2 - first2) 回の述語の適用。
InputIt1 と InputIt2 が RandomAccessIterator の要件を満たし、 last1 - first1 != last2 - first2 である場合、述語の適用は行われません (いかなる要素も見ずにサイズの不一致が検出されます)。

2,4,6,8)(1,3,5,7) と同じですが、計算量は「多くとも〜」ではなく、 O(〜) として規定されます。

例

テンプレート引数 ExecutionPolicy を持つオーバーロードは以下のようにエラーを報告します。

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

実装例

1つめのバージョン
template<class InputIt1, class InputIt2>bool equal(InputIt1 first1, InputIt1 last1, InputIt2 first2){for(; first1 != last1;++first1, ++first2){if(!(*first1 ==*first2)){returnfalse;}}returntrue;}
2つめのバージョン
template<class InputIt1, class InputIt2, class BinaryPredicate>bool equal(InputIt1 first1, InputIt1 last1, InputIt2 first2, BinaryPredicate p){for(; first1 != last1;++first1, ++first2){if(!p(*first1, *first2)){returnfalse;}}returntrue;}

例

以下のコードは文字列が回文かどうかを判定するために equal() を使用します。

Run this code

#include <algorithm>#include <iostream>#include <string>   bool is_palindrome(conststd::string& s){return std::equal(s.begin(), s.begin()+ s.size()/2, s.rbegin());}   void test(conststd::string& s){std::cout<<"\""<< s <<"\" "<<(is_palindrome(s)?"is":"is not")<<" a palindrome\n";}   int main(){ test("radar"); test("hello");}

出力:

"radar" is a palindrome "hello" is not a palindrome

関連項目

findfind_iffind_if_not (C++11)	一定の基準を満たす最初の要素を探します (関数テンプレート)
lexicographical_compare	ある範囲が別の範囲より辞書的に小さいかどうか調べます (関数テンプレート)
mismatch	2つの範囲が異なる最初の位置を探します (関数テンプレート)
search	指定範囲の要素に対して検索を行います (関数テンプレート)