Namespaces
Variants
Views
Actions

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

From cppreference.com
< cpp‎ | utility
(→‎Comparisons: +)
(→‎Comparisons: fix inverted comparisons)
Line 78: Line 78:
  
 
{{member | operator&lt; | 2=
 
{{member | operator&lt; | 2=
−
{{ddcl | 1=
+
{{dcl begin}}
 +
{{dcl | num=1 |1=
 
friend constexpr bool operator<(partial_ordering v, /*unspecified*/ u) noexcept;
 
friend constexpr bool operator<(partial_ordering v, /*unspecified*/ u) noexcept;
 +
}}
 +
{{dcl | num=2 | 1=
 
friend constexpr bool operator<(/*unspecified*/ u, partial_ordering v) noexcept;
 
friend constexpr bool operator<(/*unspecified*/ u, partial_ordering v) noexcept;
 
}}
 
}}
 +
{{dcl end}}
  
 
===Parameters===
 
===Parameters===
Line 90: Line 94:
  
 
===Return value===
 
===Return value===
−
{{c|true}} if {{tt|v}} is {{tt|less}}, and {{c|false}} if {{tt|v}} is {{tt|greater}}, {{tt|equivalent}}, or {{tt|unordered}}
+
@1@ {{c|true}} if {{tt|v}} is {{tt|less}}, and {{c|false}} if {{tt|v}} is {{tt|greater}}, {{tt|equivalent}}, or {{tt|unordered}}
 +
@2@ {{c|true}} if {{tt|v}} is {{tt|greater}}, and {{c|false}} if {{tt|v}} is {{tt|less}}, {{tt|equivalent}}, or {{tt|unordered}}
 
}}
 
}}
  
 
{{member | operator&lt;{{=}} | 2=
 
{{member | operator&lt;{{=}} | 2=
−
{{ddcl | 1=
+
{{dcl begin}}
 +
{{dcl | num=1 |1=
 
friend constexpr bool operator<=(partial_ordering v, /*unspecified*/ u) noexcept;
 
friend constexpr bool operator<=(partial_ordering v, /*unspecified*/ u) noexcept;
 +
}}
 +
{{dcl | num=2 | 1=
 
friend constexpr bool operator<=(/*unspecified*/ u, partial_ordering v) noexcept;
 
friend constexpr bool operator<=(/*unspecified*/ u, partial_ordering v) noexcept;
 
}}
 
}}
 +
{{dcl end}}
 +
  
 
===Parameters===
 
===Parameters===
Line 106: Line 116:
  
 
===Return value===
 
===Return value===
−
{{c|true}} if {{tt|v}} is {{tt|less}} or {{tt|equivalent}}, and {{c|false}} if {{tt|v}} is {{tt|greater}} or {{tt|unordered}}
+
@1@ {{c|true}} if {{tt|v}} is {{tt|less}} or {{tt|equivalent}}, and {{c|false}} if {{tt|v}} is {{tt|greater}} or {{tt|unordered}}
 +
@2@ {{c|true}} if {{tt|v}} is {{tt|greater}} or {{tt|equivalent}}, and {{c|false}} if {{tt|v}} is {{tt|less}} or {{tt|unordered}}
 
}}
 
}}
  
 
{{member | operator&gt; | 2=
 
{{member | operator&gt; | 2=
−
{{ddcl | 1=
+
{{dcl begin}}
 +
{{dcl | num=1 |1=
 
friend constexpr bool operator>(partial_ordering v, /*unspecified*/ u) noexcept;
 
friend constexpr bool operator>(partial_ordering v, /*unspecified*/ u) noexcept;
 +
}}
 +
{{dcl | num=2 | 1=
 
friend constexpr bool operator>(/*unspecified*/ u, partial_ordering v) noexcept;
 
friend constexpr bool operator>(/*unspecified*/ u, partial_ordering v) noexcept;
 
}}
 
}}
 +
{{dcl end}}
  
 
===Parameters===
 
===Parameters===
Line 122: Line 137:
  
 
===Return value===
 
===Return value===
−
{{c|true}} if {{tt|v}} is {{tt|greater}}, and {{c|false}} if {{tt|v}} is {{tt|less}}, {{tt|equivalent}}, or {{tt|unordered}}
+
@1@ {{c|true}} if {{tt|v}} is {{tt|greater}}, and {{c|false}} if {{tt|v}} is {{tt|less}}, {{tt|equivalent}}, or {{tt|unordered}}
 +
@2@ {{c|true}} if {{tt|v}} is {{tt|less}}, and {{c|false}} if {{tt|v}} is {{tt|greater}}, {{tt|equivalent}}, or {{tt|unordered}}
 
}}
 
}}
  
 
{{member | operator&gt;{{=}} | 2=
 
{{member | operator&gt;{{=}} | 2=
−
{{ddcl | 1=
+
{{dcl begin}}
 +
{{dcl | num=1 |1=
 
friend constexpr bool operator>=(partial_ordering v, /*unspecified*/ u) noexcept;
 
friend constexpr bool operator>=(partial_ordering v, /*unspecified*/ u) noexcept;
 +
}}
 +
{{dcl | num=2 |1=
 
friend constexpr bool operator>=(/*unspecified*/ u, partial_ordering v) noexcept;
 
friend constexpr bool operator>=(/*unspecified*/ u, partial_ordering v) noexcept;
 
}}
 
}}
 +
{{dcl end}}
  
 
===Parameters===
 
===Parameters===
Line 138: Line 158:
  
 
===Return value===
 
===Return value===
−
{{c|true}} if {{tt|v}} is {{tt|greater}} or {{tt|equivalent}}, and {{c|false}} if {{tt|v}} is {{tt|less}} or {{tt|unordered}}
+
@1@{{c|true}} if {{tt|v}} is {{tt|greater}} or {{tt|equivalent}}, and {{c|false}} if {{tt|v}} is {{tt|less}} or {{tt|unordered}}
 +
@2@{{c|true}} if {{tt|v}} is {{tt|less}} or {{tt|equivalent}}, and {{c|false}} if {{tt|v}} is {{tt|greater}} or {{tt|unordered}}
 
}}
 
}}
 
{{member | operator<{{=}}> | 2=
 
{{member | operator<{{=}}> | 2=

Revision as of 12:53, 26 April 2018

 
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) 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.
  • admits incomparable values: a < b, a == b, and a > b may all be false

Contents

Constants

The type std::partial_ordering has four 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::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
(public member function)

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

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 partial_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==(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;
 (1)
friend constexpr bool operator<(/*unspecified*/ u, partial_ordering v) noexcept;
 (2)

Parameters

v - a std::partial_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, equivalent, or unordered
2) 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;
 (1)
friend constexpr bool operator<=(/*unspecified*/ u, partial_ordering v) noexcept;
 (2)


Parameters

v - a std::partial_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 or unordered
2) true if v is greater or equivalent, and false if v is less or unordered

operator>

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

Parameters

v - a std::partial_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, equivalent, or unordered
2) 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;
 (1)
friend constexpr bool operator>=(/*unspecified*/ u, partial_ordering v) noexcept;
 (2)

Parameters

v - a std::partial_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 or unordered
2) true if v is less or equivalent, and false if v is greater or unordered

operator<=>

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

Parameters

v - a std::partial_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.

Notes

The built-in operator <=> between floating-point values uses this ordering: the positive zero and the negative zero compare equivalent, but can be distinguished, and NaN values compare unordered with any other value.

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=101732"