Namespaces
Variants
Views
Actions

C++ named requirements: EqualityComparable

From cppreference.com
< cpp‎ | named req
 
 
C++ named requirements
Basic
Type properties
Library-Wide
EqualityComparable
(C++11)
(C++11)
Container
Container Elements
Iterator
Stream I/O
Random Numbers
Concurrency
(C++11)

(C++11)
(C++11)
Other
 

The type must work with == operator and the result should have standard semantics.

[edit] Requirements

The type T satisfies EqualityComparable if

Given

  • a, b, and c, expressions of type T or const T

The following expressions must be valid and have their specified effects

Expression Return type Requirements
a == b implicitly convertible to bool Establishes an equivalence relation, that is, it satisfies the following properties:
  • For all values of a, a == a yields true.
  • If a == b, then b == a
  • If a == b and b == c, then a == c

[edit] Notes

To satisfy this requirement, types that do not have built-in comparison operators have to provide a user-defined operator==.

For the types that are both EqualityComparable and LessThanComparable, the C++ standard library makes a distinction between equality, which is the value of the expression a == b and equivalence, which is the value of the expression !(a < b) && !(b < a).

[edit] See also

specifies that operator == is an equivalence relation
(concept) [edit]