std::compare_three_way

 

C++

语言

标准库头文件

自立与有宿主实现

具名要求

语言支持库

概念库 (C++20)

诊断库

工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

输入/输出库

本地化库

正则表达式库 (C++11)

原子操作库 (C++11)

线程支持库 (C++11)

文件系统库 (C++17)

技术规范

 

工具库

类型支持（基本类型、 RTTI 、类型特性）
动态内存管理
错误处理
程序工具
变参数函数
库特性测试宏
日期和时间
函数对象
格式化库 (C++20)
initializer_list (C++11)
source_location (C++20)
bitset
hash (C++11)
integer_sequence (C++14)
关系运算符 (C++20 中弃用)
rel_ops::operator!=rel_ops::operator>rel_ops::operator<=rel_ops::operator>=
比较 (C++20)
three_way_comparablethree_way_comparable_with
strong_ordering weak_ordering partial_ordering common_comparison_category compare_three_way_result compare_three_way	strong_order weak_order partial_order compare_strong_order_fallback compare_weak_order_fallback compare_partial_order_fallback	is_eqis_neqis_ltis_lteqis_gtis_gteq
共用词汇类型
pair tuple (C++11) apply (C++17) make_from_tuple (C++17)	optional (C++17) any (C++17) variant (C++17)
swap 、 forward 与 move
swap
exchange (C++14)
forward (C++11)
move (C++11)
move_if_noexcept (C++11)
初等字符串转换
to_chars (C++17)
from_chars (C++17)
chars_format (C++17)
类型运算
declval (C++11)
as_const (C++17)
launder (C++17)

 

定义于头文件 <compare>
struct compare_three_way;		(C++20 起)

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

成员类型

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

成员函数

operator()

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

std::compare_three_way::operator()

template<class T, class U>     requires std::three_way_comparable_with<T, U> ||              /* std::declval<T>() <=> std::declval<U>() 解析到比较指针的内建运算符 */ constexpr auto operator()(T&& t, U&& u) const;

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

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

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

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

相等性保持

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

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

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

示例

运行此代码

#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

参阅

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