std::weak_order

 

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> で定義
inline namespace /* 未指定 */ {     inline constexpr /* 不明 */ weak_order = /* 不明 */; }		(C++20以降)
呼び出しシグネチャ
template< class T, class U >     requires /* 以下を参照 */ constexpr std::weak_ordering weak_order(T&& t, U&& u) noexcept(/* 以下参照 */);

2つの値を3方向比較を用いて比較し、std::weak_ordering 型の結果を生成します。

t と u が式であり、T と U がそれぞれ decltype((t)) および decltype((u)) を表す場合、std::weak_order(t, u) は、次のように式相当（expression-equivalent）となります。

• もしstd::is_same_v<std::decay_t<T>, std::decay_t<U>>がtrueの場合
  • std::weak_ordering(weak_order(t, u))。ただし、これは std::weak_order の宣言を含まないコンテキストでオーバーロード解決が行われた場合、well-formed な式である場合。
  • そうでなく、T が浮動小数点型の場合
    • もし std::numeric_limits<T>::is_iec559 が true であれば、浮動小数点値の弱順序比較（以下参照）を実行し、その結果を std::weak_ordering 型の値として返します。
    • そうでなければ、T の比較演算子によって観測される順序と一貫性のある std::weak_ordering 型の値を生成します。
  • そうでなければ、std::weak_ordering(std::compare_three_way()(t, u))。ただし、これは well-formed な場合。
  • そうでなければ、std::weak_ordering(std::strong_order(t, u))。ただし、これは well-formed な場合。
• その他のすべての場合、式は不正形式であり、テンプレートインスタンス化の直接コンテキストに現れる場合、置換失敗を引き起こす可能性があります。

カスタマイゼーションポイントオブジェクト

std::weak_order という名前は、*カスタマイズポイントオブジェクト* を表します。これは、リテラルな semiregular クラス型の const 関数オブジェクトです。説明のために、その型の cv 修飾されていないバージョンを __weak_order_fn と表記します。

__weak_order_fn のすべてのインスタンスは等価です。異なる __weak_order_fn 型のインスタンスを同じ引数で呼び出す効果は、インスタンスを表す式が左辺値か右辺値か、また const 修飾されているか否かにかかわらず同等です（ただし、volatile 修飾されたインスタンスは呼び出し可能であることが要求されません）。したがって、std::weak_order は自由にコピーでき、そのコピーは相互に交換可能に使用できます。

Args... という型のセットが与えられた場合、std::declval<Args>()... が上記の std::weak_order の引数に対する要件を満たす場合、__weak_order_fn は以下をモデル化します。

• std::invocable<__weak_order_fn, Args...>,
• std::invocable<const __weak_order_fn, Args...>,
• std::invocable<__weak_order_fn&, Args...>、および
• std::invocable<const __weak_order_fn&, Args...>.
  

それ以外の場合、__weak_order_fn の関数呼び出し演算子のいずれもオーバーロード解決に参加しません。

IEEE 浮動小数点型の厳密弱順序

x と y が同じ IEEE 浮動小数点型の値であり、weak_order_less(x, y) が C++ 標準によって定義された厳密弱順序において x が y に先行するかどうかを示すブール値であるとします。

• Neither x nor y is NaN の場合、weak_order_less(x, y) == true は x < y であるとき、かつそのときに限り真です。つまり、等価な浮動小数点値のすべての表現は等価です。
• x が負の NaN であり、y が負の NaN でない場合、weak_order_less(x, y) == true です。
• x が正の NaN でなく、y が正の NaN である場合、weak_order_less(x, y) == true です。
• Both x and y are NaNs with the same sign の場合、(weak_order_less(x, y) || weak_order_less(y, x)) == false です。つまり、同じ符号を持つすべての NaN は等価です。

関連項目

weak_ordering (C++20)	6つすべての演算子をサポートし、置換可能ではない三方比較の結果型 (クラス)
strong_order (C++20)	三方比較を行い、std::strong_ordering 型の結果を生成する (カスタマイゼーションポイントオブジェクト)
partial_order (C++20)	三方比較を行い、std::partial_ordering 型の結果を生成する (カスタマイゼーションポイントオブジェクト)
compare_weak_order_fallback (C++20)	operator<=> が利用できなくても、三方比較を行い std::weak_ordering 型の結果を生成する (カスタマイゼーションポイントオブジェクト)