Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/algorithm/min"

From cppreference.com
< cpp‎ | algorithm
(fix)
(fix definition)
Line 13: Line 13:
 
{{ddcl list item | num=3 | notes={{mark c++11 feature}} |
 
{{ddcl list item | num=3 | notes={{mark c++11 feature}} |
 
template< class T >
 
template< class T >
const T& min( std::initializer_list ilist);
+
T min( std::initializer_list ilist);
 
}}
 
}}
 
{{ddcl list item | num=4 | notes={{mark c++11 feature}} |
 
{{ddcl list item | num=4 | notes={{mark c++11 feature}} |
 
template< class T, class Compare >
 
template< class T, class Compare >
const T& min( std::initializer_list ilist, Compare comp );
+
T min( std::initializer_list ilist, Compare comp );
 
}}
 
}}
 
{{ddcl list end}}
 
{{ddcl list end}}

Revision as of 04:56, 17 August 2011

Template:cpp/algorithm/sidebar 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 ilist);
</td>

<td > (3) </td> <td > Template:mark c++11 feature </td> </tr> <tr class="t-dcl ">

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

<td > (4) </td> <td > Template:mark c++11 feature </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 Template:cpp 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.

Return value

1-2) The smaller of a and b.

3-4) The smallest value in ilist.

Complexity

1-2) Template:complex constant

3-4)

Equivalent function

Template:eq fun cpp

Example

Template:example cpp

See also

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