std::weak_ordering

C++

Language

Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library (C++20)

Diagnostics library

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

Utilities library

Type support (basic types, RTTI, type traits)
Dynamic memory management
Error handling
Program utilities
Variadic functions
Library feature-test macros
Date and time
Function objects
initializer_list (C++11)
bitset
hash (C++11)
integer_sequence (C++14)
Relational operators (deprecated)
rel_ops::operator!=rel_ops::operator>rel_ops::operator<=rel_ops::operator>=
Comparisons (C++20)
strong_order weak_order partial_order strong_equal weak_equal	strong_ordering weak_ordering partial_ordering strong_equality weak_equality	is_eqis_neqis_ltis_lteqis_gtis_gteq
common_comparison_category
Common vocabulary types
pair tuple (C++11) apply (C++17) make_from_tuple (C++17)	optional (C++17) any (C++17) variant (C++17)
Swap, forward and move
swap
exchange (C++14)
forward (C++11)
move (C++11)
move_if_noexcept (C++11)
Elementary string conversions
to_chars (C++17)
from_chars (C++17)
chars_format (C++17)
Type operations
declval (C++11)
as_const (C++17)

Defined in header <compare>
class weak_ordering;		(since C++20)

The class type std::weak_ordering is the result type of a three-way comparison that

• admits all six relational operators (==,!=, <, <=, >, >=)

• does not imply substitutability: if a is equivalent to b, f(a) may not be equivalent to f(b), where f denotes a function that reads only comparison-salient state that is accessible via the argument's public const members. In other words, equivalent values may be distinguishable.
• does not allow incomparable values: at least one of a < b, a == b, and a > b must be true

Constants

The type std::weak_ordering has three valid values, implemented as const static data members of its type:

Member constant	Definition
less(inline constexpr) [static]	a valid value of the type std::weak_ordering indicating less-than (ordered before) relationship (public static member constant)
equivalent(inline constexpr) [static]	a valid value of the type std::weak_ordering indicating equivalence (neither ordered before nor ordered after) (public static member constant)
greater(inline constexpr) [static]	a valid value of the type std::weak_ordering indicating greater-than (ordered after) relationship (public static member constant)

Conversions

std::weak_ordering is implicitly-convertible to std::weak_equality and std::partial_ordering, while std::strong_ordering is implicitly-convertible to weak_ordering.

operator weak_equality

implicit conversion to std::weak_equality (public member function)

std::weak_ordering::operator weak_equality

constexpr operator weak_equality() const noexcept;

Return value

std::weak_equality::equivalent if v is equivalent, std::weak_equality::nonequivalent if v is less or greater.

operator partial_ordering

implicit conversion to std::partial_ordering (public member function)

std::weak_ordering::operator partial_ordering

constexpr operator partial_ordering() const noexcept;

Return value

std::partial_ordering::less if v is less, std::partial_ordering::greater if v is greater, std::partial_ordering::equivalent if v is equivalent.

Comparisons

Comparison operators are defined between values of this type and literal 0. This supports the expressions a <=> b == 0 or a <=> b < 0 that can be used to convert the result of a three-way comparison operator to a boolean relationship; see std::is_eq, std::is_lt, etc.

The behavior of a program that attempts to compare a weak_ordering with anything other than the integer literal 0 is undefined.

operator==operator!=operator<operator>operator<=operator>=operator<=>

compares with zero (function)

operator==

friend constexpr bool operator==(weak_ordering v, /*unspecified*/ u) noexcept; friend constexpr bool operator==(/*unspecified*/ u, weak_ordering v) noexcept;

Parameters

v	-	a std::weak_ordering value to check
u	-	an unused parameter of any type that accepts literal zero argument

Return value

true if v is equivalent, false if v is less or greater

operator!=

friend constexpr bool operator!=(weak_ordering v, /*unspecified*/ u) noexcept; friend constexpr bool operator!=(/*unspecified*/ u, weak_ordering v) noexcept;

Parameters

v	-	a std::weak_ordering value to check
u	-	an unused parameter of any type that accepts literal zero argument

Return value

true if v is less or greater, and false if v is equivalent

operator<

friend constexpr bool operator<(weak_ordering v, /*unspecified*/ u) noexcept;	(1)
friend constexpr bool operator<(/*unspecified*/ u, weak_ordering v) noexcept;	(2)

Parameters

v	-	a std::weak_ordering value to check
u	-	an unused parameter of any type that accepts literal zero argument

Return value

1) true if v is less, and false if v is greater or equivalent

2) true if v is greater, and false if v is less or equivalent

operator<=

friend constexpr bool operator<=(weak_ordering v, /*unspecified*/ u) noexcept;	(1)
friend constexpr bool operator<=(/*unspecified*/ u, weak_ordering v) noexcept;	(2)

Parameters

v	-	a std::weak_ordering value to check
u	-	an unused parameter of any type that accepts literal zero argument

Return value

1) true if v is less or equivalent, and false if v is greater

2) true if v is greater or equivalent, and false if v is less

operator>

friend constexpr bool operator>(weak_ordering v, /*unspecified*/ u) noexcept;	(1)
friend constexpr bool operator>(/*unspecified*/ u, weak_ordering v) noexcept;	(2)

Parameters

v	-	a std::weak_ordering value to check
u	-	an unused parameter of any type that accepts literal zero argument

Return value

1) true if v is greater, and false if v is less or equivalent

2) true if v is less, and false if v is greater or equivalent

operator>=

friend constexpr bool operator>=(weak_ordering v, /*unspecified*/ u) noexcept;	(1)
friend constexpr bool operator>=(/*unspecified*/ u, weak_ordering v) noexcept;	(2)

Parameters

v	-	a std::weak_ordering value to check
u	-	an unused parameter of any type that accepts literal zero argument

Return value

1) true if v is greater or equivalent, and false if v is less

2) true if v is less or equivalent, and false if v is greater

operator<=>

friend constexpr weak_ordering operator<=>(weak_ordering v, /*unspecified*/ u) noexcept;	(1)
friend constexpr weak_ordering operator<=>(/*unspecified*/ u, weak_ordering v) noexcept;	(2)

Parameters

v	-	a std::weak_ordering value to check
u	-	an unused parameter of any type that accepts literal zero argument

Return value

1) v.

2) greater if v is less, less if v is greater, otherwise v.

See also

strong_ordering (C++20)	the result type of 3-way comparison that supports all 6 operators and is substitutable (class)
partial_ordering (C++20)	the result type of 3-way comparison that supports all 6 operators, is not substitutable, and allows incomparable values (class)
strong_equality (C++20)	the result type of 3-way comparison that supports only equality/inequality and is substitutable (class)
weak_equality (C++20)	the result type of 3-way comparison that supports only equality/inequality and is not substitutable (class)