std::weak_ordering

 

C++

言語

標準ライブラリヘッダ

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

名前付き要件

言語サポートライブラリ

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

診断ライブラリ

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

文字列ライブラリ

コンテナライブラリ

イテレータライブラリ

範囲ライブラリ(C++20)

アルゴリズムライブラリ

数値演算ライブラリ

ローカライゼーションライブラリ

入出力ライブラリ

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

正規表現ライブラリ(C++11)

アトミック操作ライブラリ(C++11)

スレッドサポートライブラリ(C++11)

技術仕様書

 

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

言語サポート 型サポート (基本型、RTTI、型特性) ライブラリの機能テストマクロ (C++20) 動的メモリ管理 プログラムユーティリティ エラー処理 コルーチンサポート(C++20) 可変長引数関数 launder (C++17) initializer_list (C++11) source_location (C++20) 三方比較 (C++20) 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_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

汎用ユーティリティ 日付と時間 関数オブジェクト 書式化ライブラリ(C++20) bitset hash (C++11) integer_sequence (C++14) 関係演算子 (C++20で非推奨) rel_ops::operator!=rel_ops::operator>rel_ops::operator<=rel_ops::operator>= 整数比較関数 cmp_equalcmp_not_equalcmp_lesscmp_greatercmp_less_thancmp_greater_than (C++20)(C++20)(C++20)(C++20)(C++20)(C++20) in_range (C++20) スワップと型操作 swap ranges::swap (C++20) exchange (C++14) declval (C++11) forward (C++11) move (C++11) move_if_noexcept (C++11) as_const (C++17) 一般的な語彙の型 pair tuple (C++11) apply (C++17) make_from_tuple (C++17) optional (C++17) any (C++17) variant (C++17) 初等文字列変換 to_chars (C++17) from_chars (C++17) chars_format (C++17)

 

ヘッダ <compare> で定義
class weak_ordering;		(C++20以上)

クラス型 std::weak_ordering は以下のような三方比較の結果の型です。

• 6つの関係演算子 (==, !=, <, <=, >, >=) がすべて使用できます。

• 代用可能性を暗示しません。 a が b と同等な場合、 f(a) は f(b) と同等ではないかもしれません。 ただし f は引数のパブリック const メンバを通してアクセス可能な比較用の状態のみを読み込む関数を表します。 別の言い方をすると、同等な値を区別できる可能性があります。
• 比較できない値を許容しません。 a < b、 a == b、 a > b のいずれかひとつは true でなければなりません。

定数

型 std::weak_ordering はその型の const 静的データメンバとして実装される3つの有効な値を持ちます。

メンバ定数	定義
less(inline constexpr) [静的]	より小さい (前に順序付けされる) 関係を表す std::weak_ordering 型の有効な値 (パブリック静的メンバ定数)
equivalent(inline constexpr) [静的]	同等 (前にも後にも順序付けされない) を表す std::weak_ordering 型の有効な値 (パブリック静的メンバ定数)
greater(inline constexpr) [静的]	より大きい (後に順序付けされる) 関係を表す std::weak_ordering 型の有効な値 (パブリック静的メンバ定数)

変換

std::weak_ordering は std::partial_ordering に暗黙に変換でき、 std::strong_ordering は weak_ordering に暗黙に変換できます。

operator partial_ordering

std::partial_ordering への暗黙の変換 (パブリックメンバ関数)

std::weak_ordering::operator partial_ordering

constexpr operator partial_ordering()constnoexcept;

戻り値

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==

friendconstexprbool operator==(weak_ordering v, /*unspecified*/ u)noexcept;	(1)
friendconstexprbool operator==(weak_ordering v, weak_ordering w)noexcept=default;	(2)

引数

v, w	-	調べる std::weak_ordering の値
u	-	リテラルのゼロを受理する任意の型の未使用な引数

戻り値

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

2) 両方の引数が同じ値を保持している場合は true、そうでなければ false。

operator<

friendconstexprbool operator<(weak_ordering v, /*unspecified*/ u)noexcept;	(1)
friendconstexprbool operator<(/*unspecified*/ u, weak_ordering v)noexcept;	(2)

引数

v	-	調べる std::weak_ordering の値
u	-	リテラルのゼロを受理する任意の型の未使用な引数

戻り値

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

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

operator<=

friendconstexprbool operator<=(weak_ordering v, /*unspecified*/ u)noexcept;	(1)
friendconstexprbool operator<=(/*unspecified*/ u, weak_ordering v)noexcept;	(2)

引数

v	-	調べる std::weak_ordering の値
u	-	リテラルのゼロを受理する任意の型の未使用な引数

戻り値

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

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

operator>

friendconstexprbool operator>(weak_ordering v, /*unspecified*/ u)noexcept;	(1)
friendconstexprbool operator>(/*unspecified*/ u, weak_ordering v)noexcept;	(2)

引数

v	-	調べる std::weak_ordering の値
u	-	リテラルのゼロを受理する任意の型の未使用な引数

戻り値

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

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

operator>=

friendconstexprbool operator>=(weak_ordering v, /*unspecified*/ u)noexcept;	(1)
friendconstexprbool operator>=(/*unspecified*/ u, weak_ordering v)noexcept;	(2)

引数

v	-	調べる std::weak_ordering の値
u	-	リテラルのゼロを受理する任意の型の未使用な引数

戻り値

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

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

operator<=>

friendconstexpr weak_ordering operator<=>(weak_ordering v, /*unspecified*/ u)noexcept;	(1)
friendconstexpr weak_ordering operator<=>(/*unspecified*/ u, weak_ordering v)noexcept;	(2)

引数

v	-	調べる std::weak_ordering の値
u	-	リテラルのゼロを受理する任意の型の未使用な引数

戻り値

1)v。

2)v が less の場合は greater、 v が greater の場合は less、そうでなければ v。

関連項目

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