std::three_way_comparable, std::three_way_comparable_with

 

C++

コンパイラサポート

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

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

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

言語サポートライブラリ

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

診断ライブラリ

メモリ管理ライブラリ

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

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

コンテナライブラリ

イテレータライブラリ

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

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

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

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

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

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

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

言語サポート 型のサポート (基本型、RTTI) ライブラリ機能検査マクロ (C++20) プログラムユーティリティ 可変引数関数 initializer_list (C++11) is_constant_evaluated (C++20) is_within_lifetime (C++26) source_location (C++20) コルーチンサポート (C++20) 契約サポート (C++26) 三方比較 three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20)   is_eqis_ltis_lteq (C++20)(C++20)(C++20)   is_neqis_gtis_gteq (C++20)(C++20)(C++20)

汎用ユーティリティ 関数オブジェクト ビット操作 (C++20) bitset hash (C++11) 関係演算子 (C++20で非推奨) rel_ops::operator!=rel_ops::operator>    rel_ops::operator<=rel_ops::operator>= 整数比較関数 cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20)   cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) スワップと型操作 swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) 共通語彙型 pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23)

 

ヘッダ <compare> で定義
template< class T, class Cat = std::partial_ordering > concept three_way_comparable =     __WeaklyEqualityComparableWith<T, T> &&     __PartiallyOrderedWith<T, T> &&     requires(const std::remove_reference_t<T>& a,              const std::remove_reference_t<T>& b) {         { a <=> b } -> __ComparesAs<Cat>;     };	(1)	(C++20以降)
template< class T, class U, class Cat = std::partial_ordering > concept three_way_comparable_with =     std::three_way_comparable<T, Cat> &&     std::three_way_comparable<U, Cat> &&     __ComparisonCommonTypeWith<T, U> &&     std::three_way_comparable<         std::common_reference_t<             const std::remove_reference_t<T>&,             const std::remove_reference_t<U>&>, Cat> &&     __WeaklyEqualityComparableWith<T, U> &&     __PartiallyOrderedWith<T, U> &&     requires(const std::remove_reference_t<T>& t,              const std::remove_reference_t<U>& u) {         { t <=> u } -> __ComparesAs<Cat>;         { u <=> t } -> __ComparesAs<Cat>;     };	(2)	(C++20以降)
template< class T, class Cat > concept __ComparesAs =     std::same_as<std::common_comparison_category_t<T, Cat>, Cat>;	(3)	(説明用*)

1) コンセプト std::three_way_comparable は、T の三方比較演算子 <=> が Cat によって示される比較カテゴリと一貫した結果を生成することを指定します。

2) コンセプト std::three_way_comparable_with は、(型が混在している可能性のある) T と U オペランドに対する三方比較演算子 <=> が Cat によって示される比較カテゴリと一貫した結果を生成することを指定します。混在したオペランドの比較は、オペランドを共通型に変換して比較するのと同等の結果を生成します。

__WeaklyEqualityComparableWith, __PartiallyOrderedWith, および __ComparisonCommonTypeWith は、説明専用のコンセプトです。equality_comparable および totally_ordered の説明を参照してください。

意味論的要件

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

1) T と Cat が std::three_way_comparable<T, Cat> をモデルするのは、型 const std::remove_reference_t<T> の左辺値 a と b が与えられた場合に、以下の条件が真であるときだけです。

• (a <=> b == 0) == bool(a == b),
• (a <=> b != 0) == bool(a != b),
• ((a <=> b) <=> 0) と (0 <=> (b <=> a)) は等しく、
• bool(a > b) == bool(b < a),
• bool(a >= b) == !bool(a < b),
• bool(a <= b) == !bool(b < a),
• (a <=> b < 0) == bool(a < b),
• (a <=> b > 0) == bool(a > b),
• (a <=> b <= 0) == bool(a <= b)、および
• (a <=> b >= 0) == bool(a >= b)、および
• Cat が std::strong_ordering に変換可能である場合、T は totally_ordered をモデルします。

2) T、U、および Cat が std::three_way_comparable_with<T, U, Cat> をモデルするのは、以下が与えられた場合のみです。

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

C を std::common_reference_t<const std::remove_reference_t<T>&, const std::remove_reference_t<U>&> とし、式 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から)

以下の条件が真である。

• t <=> u と u <=> t は同じ領域を持ち、
• ((t <=> u) <=> 0) と (0 <=> (u <=> t)) は等しく、
• (t <=> u == 0) == bool(t == u),
• (t <=> u != 0) == bool(t != u),
• Cat(t <=> u) == Cat(CONVERT_TO<C>(t2) <=> CONVERT_TO<C>(u2)),
• (t <=> u < 0) == bool(t < u),
• (t <=> u > 0) == bool(t > u),
• (t <=> u <= 0) == bool(t <= u),
• (t <=> u >= 0) == bool(t >= u)、および
• Cat が std::strong_ordering に変換可能である場合、T と U は std::totally_ordered_with<T, U> をモデルします。

等価性保持

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

暗黙の式バリエーション

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

関連項目

equality_comparableequality_comparable_with (C++20)	演算子==が同値関係であることを規定する (コンセプト)
totally_orderedtotally_ordered_with (C++20)	その型の比較演算子が全順序をもたらすことを規定する (コンセプト)