std::ranges::equal_to

From cppreference.com
< cpp‎ | utility‎ | functional
 
 
Utilities library
General utilities
Date and time
Function objects
Formatting library (C++20)
(C++11)
Relational operators (deprecated in C++20)
Integer comparison functions
(C++20)(C++20)(C++20)   
(C++20)
Swap and type operations
(C++14)
(C++11)
(C++11)
(C++11)
(C++17)
Common vocabulary types
(C++11)
(C++17)
(C++17)
(C++17)
(C++11)
(C++17)
(C++23)
Elementary string conversions
(C++17)
(C++17)
 
Function objects
Function wrappers
(C++11)
(C++11)
Partial function application
(C++20)(C++23)
(C++11)
Function invocation
(C++17)(C++23)
Identity function object
(C++20)
Reference wrappers
(C++11)(C++11)
Transparent operator wrappers
(C++14)
(C++14)
(C++14)
(C++14)  
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)

Negators
(C++17)
Searchers
Constrained comparators
ranges::equal_to
(C++20)
Old binders and adaptors
(until C++17*)
(until C++17*)
(until C++17*)
(until C++17*)
(until C++17*)(until C++17*)(until C++17*)(until C++17*)
(until C++20*)
(until C++20*)
(until C++17*)(until C++17*)
(until C++17*)(until C++17*)

(until C++17*)
(until C++17*)(until C++17*)(until C++17*)(until C++17*)
(until C++20*)
(until C++20*)
 
Defined in header <functional>
struct equal_to;
(since C++20)

Function object for performing comparisons. The parameter types of the function call operator (but not the return type) are deduced from the arguments.

Implementation-defined strict total order over pointers

The function call operator yields the implementation-defined strict total order over pointers if the = operator between arguments invokes a built-in comparison operator for a pointer, even if the built-in = operator does not.

The implementation-defined strict total order is consistent with the partial order imposed by built-in comparison operators (<=>, <, >, <=, and >=), and consistent among following standard function objects:

Member types

Member type Definition
is_transparent /* unspecified */

Member functions

checks if the arguments are equal
(public member function)

std::ranges::equal_to::operator()

template< class T, class U >

    requires std::equality_comparable_with<T, U> // with different semantic requirements

constexpr bool operator()( T&& t, U&& u ) const;

Compares t and u, equivalent to return std::forward<T>(t) == std::forward<U>(u);, except when that expression resolves to a call to a built-in operator== comparing pointers.

When a call would not invoke a built-in operator comparing pointers, the behavior is undefined if std::equality_comparable_with<T, U> is not modeled.

When a call would invoke a built-in operator comparing pointers of type P, the result is instead determined as follows:

  • Returns false if one of the (possibly converted) value of the first argument and the (possibly converted) value of the second argument precedes the other in the implementation-defined strict total ordering over all pointer values of type P. This strict total ordering is consistent with the partial order imposed by the built-in operators <, >, <=, and >=.
  • Otherwise (neither precedes the other), returns true.

The behavior is undefined unless the conversion sequences from both T and U to P are equality-preserving.

Equality preservation

Expressions declared in requires-expressions of the standard library concepts are required to be equality-preserving (except where stated otherwise).

Notes

Compared to std::equal_to, std::ranges::equal_to additionally requires != to be valid, and that both argument types are required to be (homogeneously) comparable with themselves (via the equality_comparable_with constraint).

Example

Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR Applied to Behavior as published Correct behavior
LWG 3530 C++20 syntactic checks were relaxed while comparing pointers only semantic requirements relaxed

See also

function object implementing x == y
(class template)