std::compare_three_way

Header: <compare>

Function object for performing comparisons. Deduces the parameter types and the return type of the function call operator.

# Declarations

struct compare_three_way;

(since C++20)

# Example

#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));
}

# Defect reports

DRApplied toBehavior as publishedCorrect behavior
LWG 3530C++20syntactic checks were relaxed while comparing pointersonly semantic requirements are relaxed

# See also