std::compare_three_way

工具库

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

通用工具

日期和时间
函数对象
bitset

格式化库 (C++20)
hash (C++11)
integer_sequence (C++14)

关系运算符 (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 与类型运算

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)
to_underlying (C++23)

常用词汇类型

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)

初等字符串转换

to_chars (C++17)
from_chars (C++17)

chars_format

(C++17)

栈踪

stacktrace_entry

(C++23)

basic_stacktrace

(C++23)

函数对象

函数包装
function (C++11)
move_only_function (C++23)
mem_fn (C++11)
bad_function_call (C++11)

部分函数应用
bind (C++11)
bind_front (C++20)
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 起)

进行比较的函数对象。从实参类型推导函数调用运算符的形参类型与返回类型。

实现定义的指针上的严格全序

若参数间的 <=> 运算符调用指针的内建比较运算符，则函数调用运算符产生实现定义的指针上的严格全序，即使内建的 <=> 运算符不如此。

实现定义的严格全序与比较运算符（ <=>、 <、 >、 <= 及 >= ）所施加的偏序一致，并在下列标准函数对象间一致：

std::less、 std::greater、 std::less_equal 及 std::greater_equal ，当模板实参为指针类型或 void 时

std::ranges::equal_to、 std::ranges::not_equal_to、 std::ranges::less、 std::ranges::greater、 std::ranges::less_equal、 std::ranges::greater_equal 及 std::compare_three_way

成员类型

成员类型	定义
`is_transparent`	/* 未指明 */

成员函数

operator()

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

std::compare_three_way::operator()

template<class T, class U> requires std::three_way_comparable_with<T, U> // 有不同的语义要求 constexpr auto operator()(T&& t, U&& u) const;

比较 t 与 u ，等价于 return std::forward<T>(t) <=> std::forward<U>(u); ，除非该表达式解析到调用比较指针的内建 operator<=> 。

当函数调用不调用内建的比较指针的运算符时，若 std::three_way_comparable_with<T, U> 未得到满足则行为未定义。

当函数调用会使用比较 P 类型指针的内建运算符时，替而以下列方式确定结果：

若第一参数的（可能为转换后的）值在 P 类型的所有指针值上的实现定义严格全序中前趋第二参数的（可能为转换后的）值，则返回 std::strong_ordering::less 。此严格全序与内建运算符 < 、 > 、 <= 及 >= 所施加的偏序一致。
否则，若第二参数的（可能为转换后的）值在同一严格全序中前趋第一参数的（可能为转换后的）值，则返回 std::strong_ordering::greater 。
否则返回 std::strong_ordering::equal 。

行为未定义，除非从 T 和 U 到 P 的转换序列均保持相等性（见后述）。

相等性保持

若表达式对给定的相等输入产生相等输出，则它保持相等性。

表达式的输入由其操作数组成。
表达式的输出由其结果和表达式所修改的所有操作数（若存在）组成。

在标准概念的规范中，操作数定义为仅包含下列内容的最大子表达式：

标识表达式，及
对 std::move 、 std::forward 与 std::declval 的调用。

每个操作数的 cv 限定与值类别，是通过假设每个模板类型形参代表一个 cv 无限定的非数组对象类型确定的。

进一步要求每个要求保持相等性的表达式都稳定：这种表达式带相同输入对象的二次求值必须拥有相等的输出，而无任何对这些输入对象的显式中间修改。

示例

运行此代码

#include <iostream>
#include <compare>
 
struct Rational_2 {
    int num;
    int den; // > 0
};
 
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\n";
    else if (value < 0)
        std::cout << "less\n";
    else
        std::cout << "greater\n";
}
 
int main()
{
    Rational_2 c{6,5};
    Rational_2 d{8,7};
    print(c <=> d);
    print(std::compare_three_way{}(c,d));
}

输出：

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 的函数对象 (类)

语言
标准库头文件
自立与有宿主实现
具名要求
语言支持库
概念库 (C++20)
诊断库
工具库
字符串库
容器库
迭代器库
范围库 (C++20)
算法库
数值库
本地化库
输入/输出库
文件系统库 (C++17)
正则表达式库 (C++11)
原子操作库 (C++11)
线程支持库 (C++11)
技术规范