std::less

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

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

Implementation-defined strict total order over pointers

A specialization of std::less for any pointer type yields the implementation-defined strict total order, 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 (<=>, (since C++20)<, >, <=, and >=), and consistent among following standard function objects:

(since C++20)

Specializations

function object implementing x < y deducing argument and return types
(class template specialization)

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 whether the first argument is less than the second
(public member function)

std::less::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 whether lhs is less than rhs.

Parameters

lhs, rhs - values to compare

Return value

For T which is not a pointer type, true if lhs < rhs, false otherwise.

For T which is a pointer type, true if lhs precedes rhs in the implementation-defined strict total order, false otherwise.

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 uses a flat address space
}

Example

#include <functional>
#include <iostream>
 
template<typename A, typename B, typename C = std::less<>>
bool fun(A a, B b, C cmp = C{})
{
    return cmp(a, b);
}
 
int main()
{
    std::cout
        << std::boolalpha
        << fun(1, 2)   << ' ' // true
        << fun(1.0, 1) << ' ' // false
        << fun(1, 2.0) << ' ' // true
        << std::less<int>{}(5, 5.6)    << ' ' // false: 5 < 5 (warn: implicit conversion)
        << std::less<double>{}(5, 5.6) << ' ' // true: 5.0 < 5.6
        << std::less<int>{}(5.6, 5.7)  << ' ' // false: 5 < 5 (warn: implicit conversion)
        << std::less{}(5, 5.6)         << ' ' // true: less<void>: 5.0 < 5.6
        << '\n';
}

Output:

true false true false true false true

See also

function object implementing x == y
(class template)
function object implementing x > y
(class template)
function object implementing x < y
(class)