Namespaces
Variants
Views
Actions

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

From cppreference.com
< cpp‎ | utility‎ | functional
(This page was missing an example. I hope mine is good enough.)
m (~)
 
(28 intermediate revisions by 19 users not shown)
Line 1: Line 1:
 
{{cpp/title|less}}
 
{{cpp/title|less}}
 
{{cpp/utility/functional/navbar}}
 
{{cpp/utility/functional/navbar}}
−
{{ddcl list begin}}
+
{{dcl begin}}
−
{{ddcl list header | functional }}
+
{{dcl header|functional}}
−
{{ddcl list item |
+
{{dcl rev multi
 +
|dcl1=
 
template< class T >
 
template< class T >
 +
struct less;
 +
|since2=c++14|dcl2=
 +
template< class T = void >
 
struct less;
 
struct less;
 
}}
 
}}
−
{{ddcl list end}}
+
{{dcl end}}
  
−
Function object for performing comparisons. Uses {{c|operator<}} on type {{tt|T}}.
+
Function object for performing comparisons. The main template invokes {{c|operator<}} on type {{tt|T}}.
  
−
===Notes===
+
===Specializations===
−
{{cpp/utility/functional/pointer_order|operator<|std::less}}
+
{{dsc begin}}
 +
{{dsc inc|cpp/utility/functional/dsc less_void}}
 +
{{dsc end}}
  
−
===Member types===
+
{{cpp/utility/functional/member types|result=bool|arg1=T|arg2=T}}
−
{{dcl list begin}}
+
−
{{dcl list hitem | type | definition }}
+
−
{{dcl list item | {{tt|result_type}} | {{tt|bool}}}}
+
−
{{dcl list item | {{tt|first_argument_type}} | {{tt|T}} }}
+
−
{{dcl list item | {{tt|second_argument_type}} | {{tt|T}} }}
+
−
{{dcl list end}}
+
  
 
===Member functions===
 
===Member functions===
−
{{dcl list begin}}
+
{{dsc begin}}
−
{{dcl list mem fun | operator() | nolink=true | checks if the first argument is ''less'' than the second}}
+
{{dsc mem fun|operator()|nolink=true|checks whether the first argument is ''less'' than the second}}
−
{{dcl list end}}
+
{{dsc end}}
  
−
{{member | {{small|std::less::}}operator() | 2=
+
{{member|{{small|std::less::}}operator()|2=
−
{{ddcl | 1=
+
{{dcl begin}}
 +
{{dcla|constexpr=c++14|1=
 
bool operator()( const T& lhs, const T& rhs ) const;
 
bool operator()( const T& lhs, const T& rhs ) const;
 
}}
 
}}
 +
{{dcl end}}
  
−
Checks whether {{tt|lhs}} is ''less'' than {{tt|rhs}}.
+
Checks whether {{c|lhs}} is ''less'' than {{c|rhs}}.
  
 
===Parameters===
 
===Parameters===
−
{{param list begin}}
+
{{par begin}}
−
{{param list item | lhs, rhs | values to compare}}
+
{{par|lhs, rhs|values to compare}}
−
{{param list end}}
+
{{par end}}
  
 
===Return value===
 
===Return value===
−
{{c|true}} if {{c|1=lhs < rhs}}, {{c|false}} otherwise.
+
{{c|lhs < rhs}}.
  
−
===Exceptions===
+
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]].
−
(none)
+
 
 +
{{cpp/impldef exception}}
  
 
===Possible implementation===
 
===Possible implementation===
−
{{eq fun | 1=
+
{{eq fun|1=
−
bool operator()(const T &lhs, const T &rhs) const  
+
constexpr bool operator()(const T& lhs, const T& rhs) const  
 
{
 
{
−
     return lhs < rhs;
+
     return lhs < rhs; // assumes that the implementation handles pointer total order
 
}
 
}
 
}}
 
}}
 
}}
 
}}
  
−
==Example==
+
===Example===
 
{{example
 
{{example
−
| code=
+
|code=
 
#include <functional>
 
#include <functional>
−
#include <iostream>
 
−
 
−
template <typename A, typename B, typename U = std::less<int>>
 
−
bool f(A a, B b, U u = U()) {
 
−
 
−
    return u(a, b);
 
  
 +
template<typename A, typename B, typename C = std::less<>>
 +
constexpr bool fun(A a, B b, C cmp = C{})
 +
{
 +
    return cmp(a, b);
 
}
 
}
  
−
int main() {
+
static_assert(fun(1, 2) == true);
 +
static_assert(fun(1.0, 1) == false);
 +
static_assert(fun(1, 2.0) == true);
 +
static_assert(std::less<int>{}(5, 5.6) == false);  // 5 < 5 (warn: implicit conversion)
 +
static_assert(std::less<double>{}(5, 5.6) == true); // 5.0 < 5.6
 +
static_assert(std::less<int>{}(5.6, 5.7) == false); // 5 < 5 (warn: implicit conversion)
 +
static_assert(std::less{}(5, 5.6) == true);        // less<void>: 5.0 < 5.6
  
−
    std::cout << std::boolalpha;
+
int main() {}
−
   
+
−
    std::cout << f(5, 20);
+
−
    std::cout << f(100, 10);
+
−
   
+
−
}
+
−
| output=
+
−
true
+
−
false
+
 
}}
 
}}
 +
 +
===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===
−
{{dcl list begin}}
+
{{dsc begin}}
−
{{dcl list template | cpp/memory/dcl list owner_less}}
+
{{dsc inc|cpp/utility/functional/dsc equal_to}}
−
{{dcl list end}}
+
{{dsc inc|cpp/utility/functional/dsc greater}}
 +
{{dsc inc|cpp/utility/functional/ranges/dsc {{SUBPAGENAMEE}}}}
 +
{{dsc end}}
  
−
[[de:cpp/utility/functional/less]]
+
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}
−
[[es:cpp/utility/functional/less]]
+
−
[[fr:cpp/utility/functional/less]]
+
−
[[it:cpp/utility/functional/less]]
+
−
[[ja:cpp/utility/functional/less]]
+
−
[[pt:cpp/utility/functional/less]]
+
−
[[ru:cpp/utility/functional/less]]
+
−
[[zh:cpp/utility/functional/less]]
+

Latest revision as of 21:14, 13 July 2024

 
C++
 
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)
(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++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. The main template invokes operator< on type T.

Contents

[edit] Specializations

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

[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)

[edit] 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;
 (constexpr since C++14)

Checks whether lhs is less than 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.

[edit] 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
}

[edit] Example

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

[edit] 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

[edit] See also

 function object implementing x == y
(class template) [edit]
function object implementing x > y
(class template) [edit]
(C++20)
 constrained function object implementing x < y
(class) [edit]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/utility/functional/less&oldid=173634"