Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/utility/functional/less equal"

From cppreference.com
< cpp‎ | utility‎ | functional
(Member types: +)
m (Text replace - "(===\s*Exceptions?\s*===\s+)\(none\)" to "{{cpp/impldef exception}}")
Line 58: Line 58:
 
{{c|true}} if {{c|1=lhs <= rhs}}, {{c|false}} otherwise.
 
{{c|true}} if {{c|1=lhs <= rhs}}, {{c|false}} otherwise.
  
===Exceptions===
+
{{cpp/impldef exception}}
(none)
+
  
 
===Possible implementation===
 
===Possible implementation===

Revision as of 17:52, 13 October 2020

 
 
Utilities library
General utilities
Relational operators (deprecated in C++20)
 
Function objects
Function invocation
(C++17)(C++23)
Identity function object
(C++20)
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)

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++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>
template< class T >
struct less_equal;
(until C++14)
template< class T = void >
struct less_equal;
(since C++14)

Function object for performing comparisons. Unless specialized, invokes operator<= on type T.

Contents

Specializations

Implementation-defined strict total order over pointers

A specialization of std::less_equal for any pointer type yields the implementation-defined strict total order, even if the built-in operator<= operator does not.

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

(since C++20)

The standard library provides a specialization of std::less_equal when T is not specified, which leaves the parameter types and return type to be deduced.

function object implementing x <= y deducing parameter and return types
(class template specialization) [edit]
(since C++14)

Member types

Type Definition
result_type (deprecated in C++17)(removed in C++20) bool
first_argument_type (deprecated in C++17)(removed in C++20) T
second_argument_type (deprecated in C++17)(removed in C++20) T

These member types are obtained via publicly inheriting std::binary_function<T, T, bool>.

(until C++11)

Member functions

operator()
checks if the first argument is less than or equal to the second
(public member function)

std::less_equal::operator()

bool operator()( const T& lhs, const T& rhs ) const;
(until C++14)
constexpr bool operator()( const T& lhs, const T& rhs ) const;
(since C++14)

Checks if lhs is less than or equal to rhs.

Parameters

lhs, rhs - values to compare

Return value

true if lhs <= rhs, false otherwise.

Exceptions

May throw implementation-defined exceptions.

Possible implementation

constexpr bool operator()(const T &lhs, const T &rhs) const 
{
    return lhs <= rhs;
}