std::compare_3way

 

C++

言語

標準ライブラリヘッダ

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

名前付き要件

言語サポートライブラリ

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

診断ライブラリ

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

文字列ライブラリ

コンテナライブラリ

イテレータライブラリ

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

アルゴリズムライブラリ

数値演算ライブラリ

入出力ライブラリ

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

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

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

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

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

技術仕様書

 

アルゴリズムライブラリ

制約付きアルゴリズムと範囲に対するアルゴリズム (C++20)
コンセプトとユーティリティ (std::Sortable, std::projected, ... )
制約付きアルゴリズム (std::ranges::copy, std::ranges::sort, ... )
実行ポリシー (C++17)
is_execution_policy	execution::seqexecution::parexecution::par_unseqexecution::unseq (C++20)	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policyexecution::parallel_unsequenced (C++20)
非変更シーケンス操作
all_ofany_ofnone_of (C++11)(C++11)(C++11) for_each for_each_n (C++17)	countcount_if mismatch equal adjacent_find	findfind_iffind_if_not (C++11) find_end find_first_of	search search_n lexicographical_compare lexicographical_compare_3way (C++20)
変更シーケンス操作
copycopy_if (C++11) copy_n (C++11) copy_backward move (C++11) move_backward (C++11) shift_leftshift_right (C++20)(C++20) transform	fill fill_n generate generate_n swap iter_swap swap_ranges sample (C++17)	removeremove_if replacereplace_if reverse rotate unique random_shuffle (C++17未満)	remove_copyremove_copy_if replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy shuffle (C++11)
未初期化記憶域の操作
uninitialized_copy uninitialized_move (C++17) uninitialized_fill	uninitialized_copy_n (C++11) uninitialized_move_n (C++17) uninitialized_fill_n	uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) destroy (C++17)	uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17) destroy_n (C++17)
分割操作
is_partitioned (C++11) partition_point (C++11)	partition partition_copy (C++11)	stable_partition
ソート操作
is_sorted (C++11) is_sorted_until (C++11)	sort stable_sort	partial_sort partial_sort_copy	nth_element
二分探索操作
lower_bound	upper_bound	binary_search	equal_range
集合操作 (ソート済み範囲用)
merge inplace_merge	set_difference set_intersection	set_symmetric_difference set_union	includes
ヒープ操作
is_heap (C++11) is_heap_until (C++11)	make_heap sort_heap	push_heap pop_heap
最小/最大演算
max max_element	min min_element	minmax (C++11) minmax_element (C++11)	clamp (C++17) compare_3way (C++20)
順列
is_permutation (C++11)	next_permutation	prev_permutation
数値演算
iota (C++11) inner_product adjacent_difference	accumulate reduce (C++17) transform_reduce (C++17)	partial_sum inclusive_scan (C++17) exclusive_scan (C++17)	transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)
C のライブラリ
qsort	bsearch

 

ヘッダ <algorithm> で定義
template< class T, class U > constexpr auto compare_3way( const T& a, const U& b );		(C++20以上)

三方比較を使用して2つの値を比較し、適用可能な最も強い比較カテゴリ型の結果を生成します。

詳細は以下の通りです。

• 式 a <=> b が well-formed であれば、その結果を返します。
• そうでなく、式 a == b および a < b がどちらも well-formed であって、 bool に変換可能であれば、

• a == b が true と等しければ、 std::strong_ordering::equal を返します。
• そうでなく、 a < b が true と等しければ、 std::strong_ordering::less を返します。
• そうでなければ、 std::strong_ordering::greater を返します。

• そうでなく、式 a == b が well-formed であって、 bool に変換可能 (しかし a < b はそうでない) であれば、

• a == b が true と等しければ、 std::strong_equality::equal を返します。
• そうでなければ、 std::strong_equality::nonequal を返します。

• そうでなければ (a <=> b と a == b がどちらも well-formed でない)、関数は削除されたものとして定義されます。

引数

a, b

-

比較する値

戻り値

上で定義されている通り。

ノート

この関数は、 <=> が利用可能でないときはフォールバックとして < および == を使用するため、総称プログラミングで便利です。

例

Run this code

#include <iostream>
#include <compare>
#include <algorithm>
 
// <=> をサポートしない型。
struct Rational_1 {
    int num;
    int den; // > 0
};
 
inline constexpr bool operator<(Rational_1 lhs, Rational_1 rhs)
{
    return lhs.num * rhs.den < rhs.num * lhs.den;
}
 
inline constexpr bool operator==(Rational_1 lhs, Rational_1 rhs)
{
    return lhs.num * rhs.den == rhs.num * lhs.den;
}
 
// <=> をサポートする型。
struct Rational_2 {
    int num;
    int den; // > 0
};
 
inline constexpr std::weak_ordering operator<=>(Rational_2 lhs, Rational_2 rhs)
{
    return lhs.num * rhs.den <=> rhs.num * lhs.den;
}
 
void print(std::weak_ordering value)
{
    if (value == 0)
        std::cout << "equal";
    else if (value < 0)
        std::cout << "less";
    else
        std::cout << "greater";
    std::cout << "\n";
}
 
int main()
{
    Rational_1 a{1,2};
    Rational_1 b{3,4};
//  print(a <=> b);                // 動作しません。
    print(std::compare_3way(a,b)); // 動作します。 < および == を使用します。
 
    Rational_2 c{6,5};
    Rational_2 d{8,7};
    print(c <=> d);                // 動作します。
    print(std::compare_3way(c,d)); // 動作します。
}

出力:

less
greater
greater

関連項目

lexicographical_compare_3way (C++20)	三方比較を使用して2つの範囲を比較します (関数テンプレート)
strong_equality (C++20)	等しい、等しくないのみサポートする代用可能な三方比較の結果の型 (クラス)
weak_equality (C++20)	等しい、等しくないのみサポートする代用可能でない三方比較の結果の型 (クラス)
strong_ordering (C++20)	6種類の演算子をすべてサポートする代用可能な三方比較の結果の型 (クラス)
weak_ordering (C++20)	6種類の演算子をすべてサポートする代用可能でない三方比較の結果の型 (クラス)
partial_ordering (C++20)	6種類の演算子をすべてサポートし、代用可能でなく、比較不可能な値を許容する、三方比較の結果の型 (クラス)