std::equality_comparable, std::equality_comparable_with

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

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

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

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

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

コンセプトライブラリ

中核言語のコンセプト same_as (C++20) derived_from (C++20) convertible_to (C++20) common_reference_with (C++20) common_with (C++20) integral (C++20) signed_integral (C++20) unsigned_integral (C++20) floating_point (C++20) swappableswappable_with (C++20)(C++20) destructible (C++20) constructible_from (C++20) default_initializable (C++20)   move_constructible (C++20) copy_constructible (C++20) assignable_from (C++20)

比較のコンセプト equality_comparableequality_comparable_with (C++20)(C++20) totally_orderedtotally_ordered_with (C++20)(C++20) オブジェクトのコンセプト movable (C++20) copyable (C++20) semiregular (C++20) regular (C++20) 呼び出し可能オブジェクトのコンセプト invocableregular_invocable (C++20)(C++20) predicate (C++20) relation (C++20) equivalence_relation (C++20) strict_weak_order (C++20)

説明専用のコンセプト boolean-testable  (C++20)

 

ヘッダ <concepts> で定義
template< class T > concept equality_comparable = __WeaklyEqualityComparableWith<T, T>;	(1)	(C++20以降)
template< class T, class U > concept equality_comparable_with =     std::equality_comparable<T> &&     std::equality_comparable<U> &&     __ComparisonCommonTypeWith<T, U> &&     std::equality_comparable<         std::common_reference_t<             const std::remove_reference_t<T>&,             const std::remove_reference_t<U>&>> &&     __WeaklyEqualityComparableWith<T, U>;	(2)	(C++20以降)
ヘルパーコンセプト
template< class T, class U > concept __WeaklyEqualityComparableWith =     requires(const std::remove_reference_t<T>& t,              const std::remove_reference_t<U>& u) {         { t == u } -> boolean-testable;         { t != u } -> boolean-testable;         { u == t } -> boolean-testable;         { u != t } -> boolean-testable;     };	(3)	(説明用*)
	(4)
template< class T, class U > concept __ComparisonCommonTypeWith =     std::common_reference_with<         const std::remove_reference_t<T>&,         const std::remove_reference_t<U>&>;			(C++23まで) (説明用*)
template< class T, class U, class C = std::common_reference_t<const T&, const U&> > concept _ComparisonCommonTypeWithImpl =     std::same_as<std::common_reference_t<const T&, const U&>,                  std::common_reference_t<const U&, const T&>> &&     requires {         requires std::convertible_to<const T&, const C&> ||             std::convertible_to<T, const C&>;         requires std::convertible_to<const U&, const C&> ||             std::convertible_to<U, const C&>;     }; template< class T, class U > concept __ComparisonCommonTypeWith =     _ComparisonCommonTypeWithImpl<std::remove_cvref_t<T>, std::remove_cvref_t<U>>;			(C++23から) (説明用*)

1) コンセプトstd::equality_comparableは、型Tにおける比較演算子==および!=が等価性を反映することを指定する。すなわち、オペランドが等しい場合に限り==がtrueとなる。

2) コンセプトstd::equality_comparable_withは、(おそらく混在した)TとUのオペランドに対する比較演算子==と!=が、等価性と一致する結果を生成することを指定する。混在したオペランドを比較すると、オペランドをその共通の型に変換して比較するのと同等の結果が得られる。

3) 表示専用コンセプト__WeaklyEqualityComparableWithは、型Tのオブジェクトと型Uのオブジェクトを、==と!=の両方を使用して相互に(どちらの順序でも)等価性について比較でき、比較の結果が一致することを指定する。

4) 表示専用コンセプト__ComparisonCommonTypeWithは、2つの型が共通の型を共有し、いずれかの型のconst左辺値または非const右辺値(C++23以降)がその共通の型に変換可能であることを指定する。

意味論的要件

これらのコンセプトは、それらが満たされ、かつそれらが含むすべてのコンセプトがモデル化されている場合にのみモデル化される。

以下の段落では、式Eと型Cが与えられたとき、CONVERT_TO<C>(E)は次のように定義される。

static_cast<C>(std::as_const(E)).	(C++23まで)
static_cast<const C&>(std::as_const(E)) (それが有効な式である場合) static_cast<const C&>(std::move(E)) (そうでない場合)	(C++23から)

1) std::equality_comparable<T> は、型Tのオブジェクトaとbが与えられた場合、bool(a == b)がaとbが等しい場合に限りtrueである場合にのみモデル化される。a == bが等価性を保持するという要件と合わせて、これは==が対称的かつ推移的であり、さらに他のオブジェクトと少なくとも1つ等しいすべてのオブジェクトaに対して==が反射的であることを意味する。

2) std::equality_comparable_with<T, U> は、次の条件が満たされる場合にのみモデル化される。

• tおよびt2は、それぞれ型const std::remove_reference_t<T>とstd::remove_cvref_t<T>の異なる等しいオブジェクトを表す左辺値であるとする。
• uおよびu2は、それぞれ型const std::remove_reference_t<U>とstd::remove_cvref_t<U>の異なる等しいオブジェクトを表す左辺値であるとする。
• Cはstd::common_reference_t<const std::remove_reference_t<T>&, const std::remove_reference_t<U>&>であるとする。

以下の式は真である。

• bool(t == u) == bool(CONVERT_TO<C>(t2) == CONVERT_TO<C>(u2)).

3) __WeaklyEqualityComparableWith<T, U> は、以下が与えられた場合にのみモデル化される。

• t: 型const std::remove_reference_t<T>の左辺値
• u: 型const std::remove_reference_t<U>の左辺値

以下の条件が真である。

• t == u、u == t、t != u、u != tは同じドメインを持つ。
• bool(u == t) == bool(t == u);
• bool(t != u) == !bool(t == u); および
• bool(u != t) == bool(t != u).

4) __WeaklyEqualityComparableWith<T, U> は、以下の場合にのみモデル化される。

対応するcommon_reference_withコンセプトがモデル化されている。	(C++23まで)
以下とする: C は std::common_reference_t<const T&, const U&> である。 t1とt2は、型std::remove_cvref_t<T>の左辺値である等価性を保持する式である。 u1とu2は、型std::remove_cvref_t<U>の左辺値である等価性を保持する式である。 以下の条件が成り立つ。 CONVERT_TO<C>(t1)は、t1がt2と等しい場合に限りCONVERT_TO<C>(t2)と等しい。および CONVERT_TO<C>(u1)は、u1がu2と等しい場合に限りCONVERT_TO<C>(u2)と等しい。	(C++23から)

等価性保持

標準ライブラリのコンセプトのrequires式で宣言された式は、(特に明記されていない限り)等価性保持である必要があります。

暗黙の式バリエーション

一部の定数左辺値オペランドに対して非変更的である式を使用するrequires式は、暗黙の式バリエーションも必要とする。

参照

• C++23標準 (ISO/IEC 14882:2024)

• 18.5.4 コンセプトequality_comparable [concept.equalitycomparable]

• C++20 standard (ISO/IEC 14882:2020)

• 18.5.3 コンセプトequality_comparable [concept.equalitycomparable]