std::compare_three_way

 

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)

 

関数オブジェクト

関数ラッパー 関数 (C++11) move_only_function (C++23) copyable_function (C++26) function_ref (C++26) mem_fn (C++11) bad_function_call (C++11)	部分関数適用 bind_frontbind_back (C++20)(C++23) bind (C++11) is_bind_expression (C++11) is_placeholder (C++11) _1, _2, _3, ... (C++11)
関数の呼び出し invokeinvoke_r (C++17)(C++23) 恒等関数オブジェクト identity (C++20)	参照ラッパー reference_wrapper (C++11) refcref (C++11)(C++11) unwrap_referenceunwrap_ref_decay (C++20)(C++20)
演算子ラッパー plus minus negate multiplies divides modulus bit_and bit_or bit_not (C++14)   bit_xor equal_to not_equal_to greater less greater_equal less_equal logical_and logical_or logical_not	透過的な演算子ラッパー plus<> (C++14) minus<> (C++14) negate<> (C++14) multiplies<> (C++14)   divides<> (C++14) modulus<> (C++14) bit_and<> (C++14) bit_or<> (C++14) bit_not<> (C++14) bit_xor<> (C++14) equal_to<> (C++14) not_equal_to<> (C++14) greater<> (C++14) less<> (C++14) greater_equal<> (C++14) less_equal<> (C++14) logical_and<> (C++14) logical_or<> (C++14) logical_not<> (C++14)
否定子 (Negators) not_fn (C++17) サーチャー default_searcher (C++17) boyer_moore_searcher (C++17) boyer_moore_horspool_searcher (C++17)	制約付き比較器 ranges::equal_to (C++20) ranges::not_equal_to (C++20) ranges::greater (C++20) ranges::less (C++20) ranges::greater_equal (C++20) ranges::less_equal (C++20) compare_three_way (C++20)
古いバインダとアダプタ
unary_function (C++17まで*) binary_function (C++17まで*) ptr_fun (C++17まで*) pointer_to_unary_function (C++17まで*) pointer_to_binary_function (C++17まで*)   mem_fun (C++17まで*) mem_fun_tmem_fun1_tconst_mem_fun_tconst_mem_fun1_t (C++17*まで)(C++17*まで)(C++17*まで)(C++17*まで) not1 (C++20まで*) not2 (C++20まで*)	binder1stbinder2nd (C++17*まで)(C++17*まで) bind1stbind2nd (C++17*まで)(C++17*まで) mem_fun_ref (C++17まで*) mem_fun_ref_tmem_fun1_ref_tconst_mem_fun_ref_tconst_mem_fun1_ref_t (C++17*まで)(C++17*まで)(C++17*まで)(C++17*まで) unary_negate (C++20まで*) binary_negate (C++20まで*)

 

ヘッダ <compare> で定義
ヘッダ <functional> で定義
struct compare_three_way;		(C++20以降)

比較を実行する関数オブジェクト。関数呼び出し演算子のパラメータ型と戻り値の型を推論します。

ネストされた型

ネストされた型	定義
is_transparent	unspecified

メンバ関数

operator()

両方の引数に対して3方向比較の結果を取得します。 (public member function)

std::compare_three_way::operator()

template< class T, class U > constexpr auto operator()( T&& t, U&& u ) const;

式 std::forward<T>(t) <=> std::forward<U>(u) を expr として

• もし expr が 組み込み の operator<=> をポインタ比較のために呼び出す結果となった場合、t と u の 複合ポインタ型 を P として

• 変換されたポインタ（型 P）を、実装定義のポインタに関する厳密な全順序で比較します。

• t が u より前に来る場合、std::strong_ordering::less を返します。
• u が t より前に来る場合、std::strong_ordering::greater を返します。
• それ以外の場合、std::strong_ordering::equal を返します。

• T から P への変換シーケンス、または U から P への変換シーケンスが 等価性を保持しない 場合、動作は未定義です。

• それ以外の場合

• expr の結果を返します。
• もし std::three_way_comparable_with<T, U> がモデル化されていない場合、動作は未定義です。

このオーバーロードは、std::three_way_comparable_with<T, U> が満たされている場合にのみ、オーバーロード解決に参加します。

例

このコードを実行

#include <compare>
#include <iostream>
 
struct Rational
{
    int num;
    int den; // > 0
 
    // Although the comparison X <=> Y will work, a direct call
    // to std::compare_three_way{}(X, Y) requires the operator==
    // be defined, to satisfy the std::three_way_comparable_with.
    constexpr bool operator==(Rational const&) const = default;
};
 
constexpr std::weak_ordering operator<=>(Rational lhs, Rational rhs)
{
    return lhs.num * rhs.den <=> rhs.num * lhs.den;
}
 
void print(std::weak_ordering value)
{
    value < 0 ? std::cout << "less\n" :
    value > 0 ? std::cout << "greater\n" :
                std::cout << "equal\n";
}
 
int main()
{
    Rational a{6, 5};
    Rational b{8, 7};
    print(a <=> b);
    print(std::compare_three_way{}(a, b));
}

出力

greater
greater

不具合報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 3530	C++20	ポインタを比較する際の構文チェックが緩和されました。	意味的な要件のみが緩和されています。

関連項目

ranges::equal_to (C++20)	x == y を実装する制約付き関数オブジェクト (クラス)
ranges::not_equal_to (C++20)	x != y を実装する制約付き関数オブジェクト (クラス)
ranges::less (C++20)	x < y を実装する制約付き関数オブジェクト (クラス)
ranges::greater (C++20)	x > y を実装する制約付き関数オブジェクト (クラス)
ranges::less_equal (C++20)	x <= y を実装する制約付き関数オブジェクト (クラス)
ranges::greater_equal (C++20)	x >= y を実装する制約付き関数オブジェクト (クラス)