Difference between revisions of "cpp/algorithm/max"

Revision as of 14:50, 6 June 2011

Template:cpp/algorithm/sidebar Template:ddcl list begin <tr class="t-dsc-header">

<td>

Defined in header <algorithm>

</td>

<td >

template< class T >
const T& max( const T& a, const T& b );

</td>

<td >

template< class T, class Compare >
const T& max( const T& a, const T& b, Compare comp );

</td>

<td > (2) </td> <td class="t-dcl-nopad"> </td> </tr> Template:ddcl list end

Returns the greater of two values. The first version uses Template:cpp to compare the values, the second version uses the given comparison function comp.

Template:params

a, b - 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.