std::min
| Defined in header <algorithm>
|
||
template< class T > const T& min( const T& a, const T& b ); |
(1) | (constexpr since C++14) |
template< class T, class Compare > const T& min( const T& a, const T& b, Compare comp ); |
(2) | (constexpr since C++14) |
template< class T > T min( std::initializer_list<T> ilist ); |
(3) | (since C++11) (constexpr since C++14) |
template< class T, class Compare > T min( std::initializer_list<T> ilist, Compare comp ); |
(4) | (since C++11) (constexpr since C++14) |
Returns the smaller of the given values.
a and b.operator< to compare the values.T is not LessThanComparable, the behavior is undefined.comp to compare the values.ilist.operator< to compare the values.T is not LessThanComparable, the behavior is undefined.comp to compare the values.Parameters
| a, b | - | the values to compare |
| ilist | - | initializer list with the values to compare |
| cmp | - | comparison function object (i.e. an object that satisfies the requirements of Compare) which returns true if a is less than b.The signature of the comparison function should be equivalent to the following:
While the signature does not need to have |
Return value
a and b. If the values are equivalent, returns a.ilist. If several values are equivalent to the smallest, returns the leftmost such value.Complexity
operator<.comp.ilist.size():operator<.comp.Possible implementation
| min (1) |
|---|
template<class T>
const T& min(const T& a, const T& b)
{
return (b < a) ? b : a;
}
|
| min (2) |
template<class T, class Compare>
const T& min(const T& a, const T& b, Compare comp)
{
return (comp(b, a)) ? b : a;
}
|
| min (3) |
template<class T>
T min(std::initializer_list<T> ilist)
{
return *std::min_element(ilist.begin(), ilist.end());
}
|
| min (4) |
template<class T, class Compare>
T min(std::initializer_list<T> ilist, Compare comp)
{
return *std::min_element(ilist.begin(), ilist.end(), comp);
}
|
Notes
Capturing the result of std::min by reference produces a dangling reference if one of the parameters is a temporary and that parameter is returned:
int n = -1;
const int& r = std::min(n + 2, n * 2); // r is dangling
Example
#include <algorithm>
#include <iostream>
#include <string_view>
int main()
{
std::cout << "smaller of 10 and 010 is " << std::min(10, 010) << '\n'
<< "smaller of 'd' and 'b' is '" << std::min('d', 'b') << "'\n"
<< "shortest of \"foo\", \"bar\", and \"hello\" is \""
<< std::min({"foo", "bar", "hello"},
[](const std::string_view s1, const std::string_view s2)
{
return s1.size() < s2.size();
}) << "\"\n";
}
Output:
smaller of 10 and 010 is 8
smaller of 'd' and 'b' is 'b'
shortest of "foo", "bar", and "hello" is "foo"
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 281 | C++98 | T was required to be CopyConstructible for overloads (1,2)
|
not required |
| LWG 2239 | C++98 C++11 |
1. T was required to be LessThanComparable foroverloads (2) (C++98) and (4) (C++11) 2. the complexity requirements were missing |
1. not required 2. added the requirements |
See also
| returns the greater of the given values (function template) | |
(C++11) |
returns the smaller and larger of two elements (function template) |
| returns the smallest element in a range (function template) | |
(C++17) |
clamps a value between a pair of boundary values (function template) |
(C++20) |
returns the smaller of the given values (algorithm function object) |