Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/algorithm/min"

From cppreference.com
< cpp‎ | algorithm
(typo)
m (r2.7.3) (Robot: Adding de, es, it, ja, pt, zh)
Line 103: Line 103:
 
{{dcl list end}}
 
{{dcl list end}}
  
 +
[[de:cpp/algorithm/min]]
 +
[[es:cpp/algorithm/min]]
 
[[fr:cpp/algorithm/min]]
 
[[fr:cpp/algorithm/min]]
 +
[[it:cpp/algorithm/min]]
 +
[[ja:cpp/algorithm/min]]
 +
[[pt:cpp/algorithm/min]]
 
[[ru:cpp/algorithm/min]]
 
[[ru:cpp/algorithm/min]]
 +
[[zh:cpp/algorithm/min]]

Revision as of 18:18, 2 November 2012

 
 
Algorithm library
Constrained algorithms and algorithms on ranges (C++20)
Constrained algorithms, e.g. ranges::copy, ranges::sort, ...
Execution policies (C++17)
Non-modifying sequence operations
Batch operations
(C++17)
Search operations
(C++11)                (C++11)(C++11)

Modifying sequence operations
Copy operations
(C++11)
(C++11)
Swap operations
Transformation operations
Generation operations
Removing operations
Order-changing operations
(until C++17)(C++11)
(C++20)(C++20)
Sampling operations
(C++17)

Sorting and related operations
Partitioning operations
Sorting operations
Binary search operations
(on partitioned ranges)
Set operations (on sorted ranges)
Merge operations (on sorted ranges)
Heap operations
Minimum/maximum operations
min
(C++11)
(C++17)
Lexicographical comparison operations
Permutation operations
C library
Numeric operations
Operations on uninitialized memory
 

Template:ddcl list begin <tr class="t-dsc-header">

<td>
Defined in header <algorithm>
</td>

<td></td> <td></td> </tr> <tr class="t-dcl ">

<td >
template< class T >
const T& min( const T& a, const T& b );
</td>

<td > (1) </td> <td class="t-dcl-nopad"> </td> </tr> <tr class="t-dcl ">

<td >
template< class T, class Compare >
const T& min( const T& a, const T& b, Compare comp );
</td>

<td > (2) </td> <td class="t-dcl-nopad"> </td> </tr> <tr class="t-dcl ">

<td >
template< class T >
T min( std::initializer_list<T> ilist);
</td>

<td > (3) </td> <td > (since C++11) </td> </tr> <tr class="t-dcl ">

<td >
template< class T, class Compare >
T min( std::initializer_list<T> ilist, Compare comp );
</td>

<td > (4) </td> <td > (since C++11) </td> </tr> Template:ddcl list end

1-2) Returns the smaller of the two values.

3-4) Returns the smallest of the values in initializer list ilist.

The (1,3) versions use operator< to compare the values, the (2,4) versions use the given comparison function comp.

Contents

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 if a is less than b.

The signature of the comparison function should be equivalent to the following:

bool cmp(const Type1& a, const Type2& b);

While the signature does not need to have const&, the function must not modify the objects passed to it and must be able to accept all values of type (possibly const) Type1 and Type2 regardless of value category (thus, Type1& is not allowed, nor is Type1 unless for Type1 a move is equivalent to a copy(since C++11)).
The types Type1 and Type2 must be such that an object of type T can be implicitly converted to both of them.

Type requirements
-
T must meet the requirements of LessThanComparable. for the overloads (1) and (3)
-
T must meet the requirements of CopyConstructible. for the overloads (3) and (4)

Return value

1-2) The smaller of a and b. If the values are equivalent, returns a.

3-4) The smallest value in ilist. If several values are equivalent to the smallest, returns the leftmost such value.

Complexity

1-2) Constant

3-4) Linear in ilist.size()

Possible implementation

First version
template<class T> 
const T& min(const T& a, const T& b)
{
    return (a < b) ? a : b;
}
Second version
template<class T, class Compare> 
const T& min(const T& a, const T& b, Compare comp)
{
    return (comp(a, b)) ? a : b;
}
Third version
template<class T>
T min( std::initializer_list<T> ilist)
{
    return *std::min_element(ilist.begin(), ilist.end());
}
Fourth version
template<class T, class Compare>
T min(std::initializer_list<T> ilist, Compare comp)
{
    return *std::min_element(ilist.begin(), ilist.end(), comp);
}

Example

#include <algorithm>
#include <iostream>
 
int main()
{
    std::cout << "smaller of 1 and 9999: " << std::min(1, 9999) << '\n';
    std::cout << "smaller of 'a' and 'b': " << std::min('a', 'b') << '\n';
    std::cout << "smaller of 3.5 and 2.5: " << std::min(3.5, 2.5) << '\n';
}

Output:

smaller of 1 and 9999: 1
smaller of 'a' and 'b': a
smaller of 3.5 and 2.5: 2.5

See also

Template:cpp/algorithm/dcl list maxTemplate:cpp/algorithm/dcl list minmaxTemplate:cpp/algorithm/dcl list min element