std::compare_three_way

来自cppreference.com
< cpp‎ | utility
 
 
工具库
通用工具
日期和时间
函数对象
格式化库 (C++20)
(C++11)
关系运算符 (C++20 中弃用)
整数比较函数
(C++20)(C++20)(C++20)
(C++20)
swap 与类型运算
(C++14)
(C++11)
(C++11)
(C++11)
(C++17)
常用词汇类型
(C++11)
(C++17)
(C++17)
(C++17)
(C++11)
(C++17)
(C++23)
初等字符串转换
(C++17)
(C++17)
 
函数对象
函数包装
(C++11)
(C++11)
部分函数应用
(C++11)
(C++20)(C++23)
函数调用
(C++17)(C++23)
恒等函数对象
(C++20)
引用包装
(C++11)(C++11)
通透运算符包装
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
取反器
(C++17)
搜索器
受约束的比较器
compare_three_way
(C++20)
旧绑定器与适配器
(C++17 前)
(C++17 前)
(C++17 前)
(C++17 前)
(C++17 前)(C++17 前)(C++17 前)(C++17 前)
(C++20 前)
(C++20 前)
(C++17 前)(C++17 前)
(C++17 前)(C++17 前)

(C++17 前)
(C++17 前)(C++17 前)(C++17 前)(C++17 前)
(C++20 前)
(C++20 前)
 
在标头 <compare> 定义
在标头 <functional> 定义
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> // 有不同的语义要求

constexpr auto operator()(T&& t, U&& u) const;

比较 tu ,等价于 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

行为未定义,除非从 TUP 的转换序列均保持相等性(见后述)。

相等性保持

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

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

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

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

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

示例

#include <iostream>
#include <compare>
 
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 在比较指针时放松了语法检查 仅放松语义要求

参阅

实现 x == y 的函数对象
(类)
实现 x != y 的函数对象
(类)
实现 x < y 的函数对象
(类)
实现 x > y 的函数对象
(类)
实现 x <= y 的函数对象
(类)
实现 x >= y 的函数对象
(类)