# std::weak_order

From cppreference.com
< cpp‎ | utility

Defined in header `<compare>` |  |
template< class T > constexpr std::weak_ordering weak_order(const T& a, const T& b); |  | (since C++20)

Compares two values using 3-way comparison and produces a result of type std::weak_ordering

Specifically,

- If the expression a <=> b is well-formed and its result is convertible to std::weak_ordering, returns that result.
- Otherwise, if the expression a <=> b is well-formed, but its result is not convertible to std::weak_ordering, then the function is defined as deleted.
- Otherwise, if the expression a <=> b is ill-formed, but the expressions a == b and a < b are both well-formed and convertible to bool,

  - if a == b is true, returns std::weak_ordering::equivalent
  - otherwise, if a < b is true, returns std::weak_ordering::less
  - otherwise, returns std::weak_ordering::greater

- Otherwise, the function is defined as deleted.

### Parameters

a, b | - | values to compare

### Return value

A value of type std::weak_ordering, as described above.

### Notes

### Example

| This section is incomplete Reason: no example

### See also

weak_ordering (C++20) | the result type of 3-way comparison that supports all 6 operators and is not substitutable (class)
strong_order (C++20) | performs 3-way comparison and produces a result of type std::strong_ordering (function template)
partial_order (C++20) | performs 3-way comparison and produces a result of type std::partial_ordering (function template)
weak_equal (C++20) | performs 3-way comparison and produces a result of type std::weak_equality (function template)

Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/utility/compare/weak_order&oldid=105543"