Namespaces
Variants
Views
Actions

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

From cppreference.com
< cpp‎ | utility‎ | functional
m (const T & -> const T&)
(Wording update for total pointer order.)
Line 13: Line 13:
 
{{dcl end}}
 
{{dcl end}}
  
Function object for performing comparisons. Unless specialized, invokes {{c|operator<{{=}}}} on type {{tt|T}}.
+
Function object for performing comparisons. The main template invokes {{c|1=operator<=}} on type {{tt|T}}.
 
+
{{cpp/utility/functional/pointer_order|<{{=}}}}
+
  
 
===Specializations===
 
===Specializations===
Line 47: Line 45:
  
 
===Return value===
 
===Return value===
For {{tt|T}} which is not a pointer type, {{c|true}} if {{c|1=lhs <= rhs}}, {{c|false}} otherwise.
+
{{c|1=lhs <= rhs}}.
  
For {{tt|T}} which is a pointer type, {{c|true}} if {{c|lhs}} does not succeed {{c|rhs}} in the implementation-defined strict total order, {{c|false}} otherwise.
+
If {{tt|T}} is a pointer type, the result is consistent with the [[cpp/language/operator comparison#Pointer total order|implementation-defined strict total order over pointers]].
  
 
{{cpp/impldef exception}}
 
{{cpp/impldef exception}}
Line 57: Line 55:
 
constexpr bool operator()(const T& lhs, const T& rhs) const  
 
constexpr bool operator()(const T& lhs, const T& rhs) const  
 
{
 
{
     return lhs <= rhs; // assumes that the implementation uses a flat address space
+
     return lhs <= rhs; // assumes that the implementation handles pointer total order
 
}
 
}
 
}}
 
}}
 
}}
 
}}
 +
 +
===Defect reports===
 +
{{dr list begin}}
 +
{{dr list item|wg=lwg|dr=2562|std=C++98|before=the pointer total order might be inconsistent|after=guaranteed to be consistent}}
 +
{{dr list end}}
  
 
===See also===
 
===See also===

Revision as of 01:37, 26 December 2023

 
 
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. The main template invokes operator<= on type T.

Contents

Specializations

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

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

lhs <= rhs.

If T is a pointer type, the result is consistent with the implementation-defined strict total order over pointers.

Exceptions

May throw implementation-defined exceptions.

Possible implementation

constexpr bool operator()(const T& lhs, const T& rhs) const 
{
    return lhs <= rhs; // assumes that the implementation handles pointer total order
}

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 2562 C++98 the pointer total order might be inconsistent guaranteed to be consistent

See also

function object implementing x < y
(class template) [edit]
constrained function object implementing x <= y
(class) [edit]