std::weak_ordering

 

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> で定義
class weak_ordering;		(C++20以降)

クラス型std::weak_orderingは、三項比較の結果型であり、

• 6つの関係演算子 (==, !=, <, <=, >, >=) をすべて許容します。

• 置換可能性を意味しません。つまり、aがbと等価であっても、f(a)はf(b)と等価ではない場合があります。ここで、fは引数のパブリックconstメンバを通じてアクセス可能な比較に関連する状態のみを読み取る関数です。言い換えると、等価な値は区別可能である可能性があります。
• 比較不能な値を許容しません。a < b、a == b、またはa > bのいずれか1つのみがtrueである必要があります。

定数

型std::weak_orderingには、その型のconst staticデータメンバとして実装された3つの有効な値があります。

名前	定義
inline constexpr std::weak_ordering less [static]	より小さい（順序が前）関係を示す有効な値 (公開静的メンバ定数)
inline constexpr std::weak_ordering equivalent [static]	等価であることを示す有効な値（順序付けられても、順序付けられていなくてもよい） (公開静的メンバ定数)
inline constexpr std::weak_ordering greater [static]	より大きい（順序が後）関係を示す有効な値 (公開静的メンバ定数)

変換

std::weak_orderingはstd::partial_orderingに暗黙的に変換可能ですが、std::strong_orderingはweak_orderingに暗黙的に変換可能です。

operator partial_ordering

std::partial_orderingへの暗黙変換 (public member function)

std::weak_ordering::operator partial_ordering

constexpr operator partial_ordering() const noexcept;

戻り値

vがlessの場合はstd::partial_ordering::less、vがgreaterの場合はstd::partial_ordering::greater、vがequivalentの場合はstd::partial_ordering::equivalent。

比較

この型の値とリテラルの​0​との間で比較演算子が定義されています。これにより、三項比較演算子の結果をブール関係に変換するために使用できる式 a <=> b == 0 または a <=> b < 0 をサポートします。詳細はstd::is_eq、std::is_ltなどを参照してください。

これらの関数は、通常の非修飾または修飾検索では表示されず、std::weak_orderingが引数に関連付けられたクラスである場合にのみ引数依存検索で見つけることができます。

weak_orderingを整数リテラル0以外のものと比較しようとするプログラムの動作は未定義です。

operator==operator<operator>operator<=operator>=operator<=>

ゼロまたはweak_orderingとの比較 (関数)

operator==

friend constexpr bool operator==( weak_ordering v, /*未指定*/ u ) noexcept;	(1)
friend constexpr bool operator==( weak_ordering v, weak_ordering w ) noexcept = default;	(2)

パラメータ

v, w	-	チェックするstd::weak_ordering値
u	-	リテラルゼロ引数を受け入れる任意の型の未使用パラメータ

戻り値

1) vがequivalentの場合はtrue、vがlessまたはgreaterの場合はfalse。

両方のパラメータが同じ値を持つ場合はtrue、それ以外の場合はfalse。

operator<

friend constexpr bool operator<( weak_ordering v, /*未指定*/ u ) noexcept;	(1)
friend constexpr bool operator<( /*未指定*/ u, weak_ordering v ) noexcept;	(2)

パラメータ

v	-	チェックするstd::weak_ordering値
u	-	リテラルゼロ引数を受け入れる任意の型の未使用パラメータ

戻り値

vがlessの場合はtrue、vがgreaterまたはequivalentの場合はfalse。

vがgreaterの場合はtrue、vがlessまたはequivalentの場合はfalse。

operator<=

friend constexpr bool operator<=( weak_ordering v, /*未指定*/ u ) noexcept;	(1)
friend constexpr bool operator<=( /*未指定*/ u, weak_ordering v ) noexcept;	(2)

パラメータ

v	-	チェックするstd::weak_ordering値
u	-	リテラルゼロ引数を受け入れる任意の型の未使用パラメータ

戻り値

vがlessまたはequivalentの場合はtrue、vがgreaterの場合はfalse。

vがgreaterまたはequivalentの場合はtrue、vがlessの場合はfalse。

operator>

friend constexpr bool operator>( weak_ordering v, /*未指定*/ u ) noexcept;	(1)
friend constexpr bool operator>( /*未指定*/ u, weak_ordering v ) noexcept;	(2)

パラメータ

v	-	チェックするstd::weak_ordering値
u	-	リテラルゼロ引数を受け入れる任意の型の未使用パラメータ

戻り値

vがgreaterの場合はtrue、vがlessまたはequivalentの場合はfalse。

vがlessの場合はtrue、vがgreaterまたはequivalentの場合はfalse。

operator>=

friend constexpr bool operator>=( weak_ordering v, /*未指定*/ u ) noexcept;	(1)
friend constexpr bool operator>=( /*未指定*/ u, weak_ordering v ) noexcept;	(2)

パラメータ

v	-	チェックするstd::weak_ordering値
u	-	リテラルゼロ引数を受け入れる任意の型の未使用パラメータ

戻り値

vがgreaterまたはequivalentの場合はtrue、vがlessの場合はfalse。

vがlessまたはequivalentの場合はtrue、vがgreaterの場合はfalse。

operator<=>

friend constexpr weak_ordering operator<=>( weak_ordering v, /*未指定*/ u ) noexcept;	(1)
friend constexpr weak_ordering operator<=>( /*未指定*/ u, weak_ordering v ) noexcept;	(2)

パラメータ

v	-	チェックするstd::weak_ordering値
u	-	リテラルゼロ引数を受け入れる任意の型の未使用パラメータ

戻り値

1) v。

2) vがlessの場合はgreater、greaterの場合はless、それ以外の場合はv。

関連項目

strong_ordering (C++20)	6つすべての演算子をサポートし、置換可能である三方比較の結果型 (クラス)
partial_ordering (C++20)	6つすべての演算子をサポートし、置換可能ではなく、比較不可能な値を許容する三方比較の結果型 (クラス)