Namespaces
Variants

    std::equal

    ja.cppreference.net より
     
    C++
    コンパイラサポート
    フリースタンディングとホスト環境
    言語
    標準ライブラリ
    標準ライブラリヘッダ
    名前付き要件
    機能テストマクロ (C++20)
    言語サポートライブラリ
    コンセプトライブラリ (C++20)
    診断ライブラリ
    メモリ管理ライブラリ
    メタプログラミングライブラリ (C++11)
    一般ユーティリティライブラリ
    コンテナライブラリ
    イテレータライブラリ
    レンジライブラリ (C++20)
    アルゴリズムライブラリ
    文字列ライブラリ
    テキスト処理ライブラリ
    数値ライブラリ
    日付と時間ライブラリ
    入出力ライブラリ
    ファイルシステムライブラリ (C++17)
    並行性サポートライブラリ (C++11)
    実行制御ライブラリ (C++26)
    技術仕様書
    シンボルインデックス
    外部ライブラリ
     
    アルゴリズムライブラリ
    制約付きアルゴリズムとレンジに対するアルゴリズム (C++20)
    制約付きアルゴリズム、例: ranges::copy、ranges::sort、...
    ソートおよび関連操作
    分割操作
    (C++11)    
    (C++11)

    ソート操作
    二分探索操作
    (分割されたレンジに対する)
    集合操作 (ソート済みレンジに対する)
    マージ操作 (ソート済みレンジに対する)
    ヒープ操作
    最小値/最大値操作
    (C++11)
    (C++17)
    辞書順比較操作
    (C++20)
    順列操作


     
    ヘッダ <algorithm> 
    template< class InputIt1, class InputIt2 >
bool equal( InputIt1 first1, InputIt1 last1,
            InputIt2 first2 );
    		で定義 (1) (C++20 から constexpr) 
    template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2 >
bool equal( ExecutionPolicy&& policy,
            ForwardIt1 first1, ForwardIt1 last1,
            ForwardIt2 first2 );
    		(2) (C++17 から) 
    template< class InputIt1, class InputIt2, class BinaryPred >
bool equal( InputIt1 first1, InputIt1 last1,
            InputIt2 first2, BinaryPred p );
    		(3) (C++20 から constexpr) 
    template< class ExecutionPolicy,
          class ForwardIt1, class ForwardIt2, class BinaryPred >
bool equal( ExecutionPolicy&& policy,
            ForwardIt1 first1, ForwardIt1 last1,
            ForwardIt2 first2, BinaryPred p );
    		(4) (C++17 から) 
    template< class InputIt1, class InputIt2 >
bool equal( InputIt1 first1, InputIt1 last1,
            InputIt2 first2, InputIt2 last2 );
    		(5) (C++14 から)
    (C++20 から constexpr)    		 
    template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2 >
bool equal( ExecutionPolicy&& policy,
            ForwardIt1 first1, ForwardIt1 last1,
            ForwardIt2 first2, ForwardIt2 last2 );
    		(6) (C++17 から) 
    template< class InputIt1, class InputIt2, class BinaryPred >
bool equal( InputIt1 first1, InputIt1 last1,
            InputIt2 first2, InputIt2 last2, BinaryPred p );
    		(7) (C++14 から)
    (C++20 から constexpr)    		 
    template< class ExecutionPolicy,
          class ForwardIt1, class ForwardIt2, class BinaryPred >
bool equal( ExecutionPolicy&& policy,
            ForwardIt1 first1, ForwardIt1 last1,
            ForwardIt2 first2, ForwardIt2 last2, BinaryPred p );
    		(8) (C++17 から)

    [first1, last1) と first2 から始まる範囲が等しいかどうかを調べます:

    • オーバーロード (1-4) では、2 番目の範囲は std::distance(first1, last1) 個の要素を持ちます。
    • オーバーロード (5-8) では、2 番目の範囲は [first2, last2) です。
    1,5) 要素は operator== を用いて比較されます。
    3,7) 要素は与えられた二項述語 p を用いて比較されます。
    2,4,6,8) (1,3,5,7) と同じですが、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 - 比較する2番目の範囲の要素を定義するイテレータのペア
    policy - 使用する実行ポリシー
    p - 要素が等しいと見なされる場合に​true を返す二項述語。

    述語関数のシグネチャは以下と同等であるべきです:

    bool pred(const Type1 &a, const Type2 &b);

    シグネチャが const & を持つ必要はありませんが、関数は渡されたオブジェクトを変更してはならず、型 (const の場合もある) Type1 および Type2 のすべての値を値カテゴリに関わらず受け入れられなければなりません (したがって、Type1 & は許可されません。また、Type1 は Type1 の場合を除き許可されません(C++11 から))。
    型 Type1 および Type2 は、型 InputIt1 および InputIt2 のオブジェクトを逆参照して、それぞれ Type1 および Type2 に暗黙変換できるようにする必要があります。 ​

    型要件
    -
    InputIt1, InputIt2 は LegacyInputIterator の要件を満たさなければなりません。
    -
    ForwardIt1, ForwardIt2 は LegacyForwardIterator の要件を満たさなければなりません。
    -
    BinaryPred は BinaryPredicate の要件を満たさなければなりません。

    戻り値

    1-4) 2 つの範囲の対応する要素がすべて等しい場合、true を返します。そうでなければ false を返します。
    5-8) std::distance(first1, last1) と std::distance(first2, last2) が等しく、かつ 2 つの範囲の対応する要素がすべて等しい場合、true を返します。そうでなければ false を返します。

    計算量

    N1 を std::distance(first1, last1) とし、N2 を std::distance(first2, last2) とします:

    1) 最大で N1 回の operator== による比較。
    2) O(N1) 回の operator== による比較。
    3) 最大で N1 回の述語 p の適用。
    4) O(N1) 回の述語 p の適用。
    5-8) InputIt1 と InputIt2 がどちらも LegacyRandomAccessIterator であり、last1 - first1 != last2 - first2 が true である場合、比較は行われません。
    そうでなければ、N を min(N1,N2) として:
    5) 最大で N 回の operator== による比較。
    6) O(N) 回の operator== による比較。
    7) 最大で N 回の述語 p の適用。
    8) O(N) 回の述語 p の適用。

    例外

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

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

    実装例

    equal (1) 
    template<class InputIt1, class InputIt2>
constexpr //< since C++20
bool equal(InputIt1 first1, InputIt1 last1, InputIt2 first2)
{
    for (; first1 != last1; ++first1, ++first2)
        if (!(*first1 == *first2))
            return false;
    
    return true;
}
    equal (3) 
    template<class InputIt1, class InputIt2, class BinaryPred>
constexpr //< since C++20
bool equal(InputIt1 first1, InputIt1 last1,
           InputIt2 first2, BinaryPred p)
{
    for (; first1 != last1; ++first1, ++first2)
        if (!p(*first1, *first2))
            return false;
    
    return true;
}
    equal (5) 
    namespace detail
{
    // random-access iterator implementation (allows quick range size detection)
    template<class RandomIt1, class RandomIt2>
    constexpr //< since C++20
    bool equal(RandomIt1 first1, RandomIt1 last1, RandomIt2 first2, RandomIt2 last2,
               std::random_access_iterator_tag, std::random_access_iterator_tag)
    {
        if (last1 - first1 != last2 - first2)
            return false;
        
        for (; first1 != last1; ++first1, ++first2)
            if (!(*first1 == *first2))
                return false;
        
        return true;
    }
    
    // input iterator implementation (needs to manually compare with “last2”)
    template<class InputIt1, class InputIt2>
    constexpr //< since C++20
    bool equal(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2,
               std::input_iterator_tag, std::input_iterator_tag)
    {
        for (; first1 != last1 && first2 != last2; ++first1, ++first2)
            if (!(*first1 == *first2))
                return false;
        
        return first1 == last1 && first2 == last2;
    }
}

template<class InputIt1, class InputIt2>
constexpr //< since C++20
bool equal(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2)
{
    details::equal(first1, last1, first2, last2,
                   typename std::iterator_traits<InputIt1>::iterator_category(),
                   typename std::iterator_traits<InputIt2>::iterator_category());
}
    equal (7) 
    namespace detail
{
    // random-access iterator implementation (allows quick range size detection)
    template<class RandomIt1, class RandomIt2, class BinaryPred>
    constexpr //< since C++20
    bool equal(RandomIt1 first1, RandomIt1 last1,
               RandomIt2 first2, RandomIt2 last2, BinaryPred p,
               std::random_access_iterator_tag, std::random_access_iterator_tag)
    {
        if (last1 - first1 != last2 - first2)
            return false;
        
        for (; first1 != last1; ++first1, ++first2)
            if (!p(*first1, *first2))
                return false;
        
        return true;
    }
    
    // input iterator implementation (needs to manually compare with “last2”)
    template<class InputIt1, class InputIt2, class BinaryPred>
    constexpr //< since C++20
    bool equal(InputIt1 first1, InputIt1 last1,
               InputIt2 first2, InputIt2 last2, BinaryPred p,
               std::input_iterator_tag, std::input_iterator_tag)
    {
        for (; first1 != last1 && first2 != last2; ++first1, ++first2)
            if (!p(*first1, *first2))
                return false;
        
        return first1 == last1 && first2 == last2;
    }
}

template<class InputIt1, class InputIt2, class BinaryPred>
constexpr //< since C++20
bool equal(InputIt1 first1, InputIt1 last1,
           InputIt2 first2, InputIt2 last2, BinaryPred p)
{
    details::equal(first1, last1, first2, last2, p,
                   typename std::iterator_traits<InputIt1>::iterator_category(),
                   typename std::iterator_traits<InputIt2>::iterator_category());
}

    注記

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

    コンテナ全体 または文字列ビュー(C++17 から) を等価性で比較する場合は、通常、対応する型の operator== が推奨されます。

    シーケンシャルな std::equal は短絡することが保証されていません。たとえば、両方の範囲の最初の要素のペアが等しく比較されない場合でも、残りの要素が比較される可能性があります。非短絡比較は、範囲が std::memcmp または実装固有のベクトル化アルゴリズムで比較される場合に発生する可能性があります。

    例

    以下のコードは、std::equal を使用して文字列が回文であるかどうかをテストします。

    このコードを実行する
    #include <algorithm>
#include <iomanip>
#include <iostream>
#include <string_view>

constexpr bool is_palindrome(const std::string_view& s)
{
    return std::equal(s.cbegin(), s.cbegin() + s.size() / 2, s.crbegin());
}

void test(const std::string_view& s)
{
    std::cout << std::quoted(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

    関連項目

    (C++11)
    		 特定の基準を満たす最初の要素を探す
    (関数テンプレート & アルゴリズム関数オブジェクト)
    (C++20)(C++20)(C++20)
    		2 つの範囲を辞書順で比較する
    (関数テンプレート & アルゴリズム関数オブジェクト)
    (C++20)
    		2 つの範囲が異なる最初の位置を探す
    (関数テンプレート & アルゴリズム関数オブジェクト)
    (C++20)
    		要素の範囲が最初に現れる位置を探す
    (関数テンプレート & アルゴリズム関数オブジェクト)
    (C++20)
    (C++20)
    		 2 つの要素の集合が同じかどうかを判定する
    (アルゴリズム関数オブジェクト)
    		x == y
    を実装する関数オブジェクト (クラステンプレート)
    		二分探索を使用して、指定された値に一致する要素の範囲を探す
    (関数テンプレート & アルゴリズム関数オブジェクト)
    (C++20)