std::compare_three_way

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

工具库

语言支持 类型支持（基本类型、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)

 

函数对象

函数包装器 function (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)
否定器 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	未指定

成员函数

operator()

获取两个参数的三路比较结果 (公开成员函数)

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++ 标准。

缺陷报告	应用于	发布时的行为	正确的行为
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 的受限函数对象 (类)