std::ranges::equal

ヘッダー `<algorithm>` で定義
呼び出しシグネチャ
template< std::input_iterator I1, std::sentinel_for<I1> S1, std::input_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 equal( I1 first1, S1 last1, I2 first2, S2 last2, Pred pred = {}, Proj1 proj1 = {}, Proj2 proj2 = {} );	(1)	(C++20以降)
template< ranges::input_range R1, ranges::input_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 equal( R1&& r1, R2&& r2, Pred pred = {}, Proj1 proj1 = {}, Proj2 proj2 = {} );	(2)	(C++20以降)

1) projectedされる値の範囲 [first1, last1) と projectedされる値の範囲 [first2, last2) が等しい場合は true を返し、そうでない場合は false を返します。

2) (1) と同じですが、ソース範囲として r を使用し、ranges::begin(r) を first、ranges::end(r) を last として使用するかのようです。

2つの範囲は、要素数が同じであり、対応するすべての projected 要素のペアが pred を満たす場合に等しいと見なされます。つまり、両方の範囲の対応する要素のすべてのペアに対して、std::invoke(pred, std::invoke(proj1, *first1), std::invoke(proj2, *first2)) が true を返します。

このページで説明されている関数のようなエンティティは、アルゴリズム関数オブジェクト（非公式にはニーブロイドとして知られている）です。つまり、

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

first1, last1	-	比較する最初の要素の range を定義するイテレータとセンチネルのペア
r1	-	比較する要素の最初の範囲
first2, last2	-	比較する2番目の要素の range を定義するイテレータとセンチネルのペア
r2	-	比較する2番目の範囲
pred	-	projected される要素に適用されるバイナリ述語
proj1	-	最初の範囲の要素に適用するプロジェクション
proj2	-	2番目の範囲の要素に適用するプロジェクション

[edit] Return value

範囲 [first1, last1) の長さが範囲 [first2, last2) の長さと等しくない場合は、false を返します。

projected された後、2つの範囲の要素が等しい場合は、true を返します。

それ以外の場合は false を返します。

[edit] Notes

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

コンテナ全体または string_view の等価性を比較する場合、通常は対応する型の operator== を使用する方が推奨されます。

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

[edit] Complexity

述語および対応する projection の適用回数は、最大で min(last1 - first1, last2 - first2) 回です。

S1 および S2 が両方とも std::sized_sentinel_for をモデル化し、それぞれのイテレータがあり、かつ last1 - first1 != last2 - first2 の場合、述語は一度も適用されません（サイズ mismatch は要素を見ることなく検出されます）。

[edit] Possible implementation

struct equal_fn
{
  template<std::input_iterator I1, std::sentinel_for<I1> S1,
           std::input_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
  {
      if constexpr (std::sized_sentinel_for<S1, I1> and std::sized_sentinel_for<S2, I2>)
          if (std::ranges::distance(first1, last1) != std::ranges::distance(first2, last2))
              return false;
 
      for (; first1 != last1; ++first1, (void)++first2)
          if (!std::invoke(pred, std::invoke(proj1, *first1), std::invoke(proj2, *first2)))
              return false;
      return true;
  }
 
  template<ranges::input_range R1, ranges::input_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 (*this)(ranges::begin(r1), ranges::end(r1),
                     ranges::begin(r2), ranges::end(r2),
                     std::ref(pred), std::ref(proj1), std::ref(proj2));
  }
};
 
inline constexpr equal_fn equal;

[edit] Example

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

このコードを実行

#include <algorithm>
#include <iomanip>
#include <iostream>
#include <ranges>
#include <string_view>
 
constexpr bool is_palindrome(const std::string_view s)
{
    namespace views = std::views;
    auto forward = s | views::take(s.size() / 2);
    auto backward = s | views::reverse | views::take(s.size() / 2);
    return std::ranges::equal(forward, backward);
}
 
void test(const std::string_view s)
{
    std::cout << std::quoted(s) << " is "
              << (is_palindrome(s) ? "" : "not ")
              << "a palindrome\n";
}
 
int main()
{
    test("radar");
    test("hello");
    static_assert(is_palindrome("ABBA") and not is_palindrome("AC/DC"));
}

出力

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

[edit] See also

ranges::findranges::find_ifranges::find_if_not (C++20)(C++20)(C++20)	特定の基準を満たす最初の要素を見つける (アルゴリズム関数オブジェクト)[編集]
ranges::lexicographical_compare (C++20)	ある範囲が別の範囲より辞書順で小さい場合に true を返す (アルゴリズム関数オブジェクト)[編集]
ranges::mismatch (C++20)	2つの範囲が異なる最初の位置を見つける (アルゴリズム関数オブジェクト)[編集]
ranges::search (C++20)	要素の範囲の最初の出現を検索する (アルゴリズム関数オブジェクト)[編集]
ranges::equal_range (C++20)	特定のキーに一致する要素の範囲を返す (アルゴリズム関数オブジェクト)[編集]
equal_to	x == y を実装する関数オブジェクト (クラステンプレート) [編集]
equal	2つの要素の集合が同じかどうかを判断する (関数テンプレート) [編集]

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

cppreference.com

名前空間

変種

表示

操作