Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/utility/compare/partial ordering"

From cppreference.com
< cpp‎ | utility
m (er, substitutability is for equiv)
m (s/unused argument/unused parameter)
Line 51: Line 51:
 
{{par begin}}
 
{{par begin}}
 
{{par | v | a {{tt|std::partial_ordering}} value to check}}
 
{{par | v | a {{tt|std::partial_ordering}} value to check}}
−
{{par | u | an unused argument of any type that accepts literal zero argument}}
+
{{par | u | an unused parameter of any type that accepts literal zero argument}}
 
{{par end}}
 
{{par end}}
  
Line 67: Line 67:
 
{{par begin}}
 
{{par begin}}
 
{{par | v | a {{tt|std::partial_ordering }} value to check}}
 
{{par | v | a {{tt|std::partial_ordering }} value to check}}
−
{{par | u | an unused argument of any type that accepts literal zero argument}}
+
{{par | u | an unused parameter of any type that accepts literal zero argument}}
 
{{par end}}
 
{{par end}}
  
Line 83: Line 83:
 
{{par begin}}
 
{{par begin}}
 
{{par | v | a {{tt|std::partial_ordering }} value to check}}
 
{{par | v | a {{tt|std::partial_ordering }} value to check}}
−
{{par | u | an unused argument of any type that accepts literal zero argument}}
+
{{par | u | an unused parameter of any type that accepts literal zero argument}}
 
{{par end}}
 
{{par end}}
  
Line 99: Line 99:
 
{{par begin}}
 
{{par begin}}
 
{{par | v | a {{tt|std::partial_ordering }} value to check}}
 
{{par | v | a {{tt|std::partial_ordering }} value to check}}
−
{{par | u | an unused argument of any type that accepts literal zero argument}}
+
{{par | u | an unused parameter of any type that accepts literal zero argument}}
 
{{par end}}
 
{{par end}}
  
Line 115: Line 115:
 
{{par begin}}
 
{{par begin}}
 
{{par | v | a {{tt|std::partial_ordering }} value to check}}
 
{{par | v | a {{tt|std::partial_ordering }} value to check}}
−
{{par | u | an unused argument of any type that accepts literal zero argument}}
+
{{par | u | an unused parameter of any type that accepts literal zero argument}}
 
{{par end}}
 
{{par end}}
  
Line 131: Line 131:
 
{{par begin}}
 
{{par begin}}
 
{{par | v | a {{tt|std::partial_ordering }} value to check}}
 
{{par | v | a {{tt|std::partial_ordering }} value to check}}
−
{{par | u | an unused argument of any type that accepts literal zero argument}}
+
{{par | u | an unused parameter of any type that accepts literal zero argument}}
 
{{par end}}
 
{{par end}}
  

Revision as of 14:50, 18 December 2017

 
C++
 
Utilities library
General utilities
Relational operators (deprecated in C++20)
 
Defined in header <compare>
class partial_ordering;
 (since C++20)

The class type std::partial_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) does not have to be equivalent to f(b)
  • admits incomparable values: a < b, a == b, and a > b may all be false

Contents

Constants

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

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

Conversions

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

operator weak_equality
 implicit conversion to std::weak_equality
(function)

std::strong_equality::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, greater, or unordered.

Comparisons

Comparison operators are defined between values of this type and literal zero. 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

operator==operator!=operator<operator>operator<=operator>=
 compares with zero
(function)

operator==

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

Parameters

v - a std::partial_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, greater, or unordered

operator!=

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

Parameters

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

Return value

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

operator<

friend constexpr bool operator<(partial_ordering v, /*unspecified*/ u) noexcept;
friend constexpr bool operator<(/*unspecified*/ u, partial_ordering v) noexcept;

Parameters

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

Return value

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

operator<=

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

Parameters

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

Return value

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

operator>

friend constexpr bool operator>(partial_ordering v, /*unspecified*/ u) noexcept;
friend constexpr bool operator>(/*unspecified*/ u, partial_ordering v) noexcept;

Parameters

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

Return value

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

operator>=

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

Parameters

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

Return value

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

Example

This section is incomplete
Reason: no example

See also

Template:cpp/utility/compare/dsc strong equalityTemplate:cpp/utility/compare/dsc weak equality
(C++20)
 the result type of 3-way comparison that supports all 6 operators and is substitutable
(class) [edit]
(C++20)
 the result type of 3-way comparison that supports all 6 operators and is not substitutable
(class) [edit]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/utility/compare/partial_ordering&oldid=97636"