max



Categories: algorithms, utilities	Component type: function

Prototype

Max is an overloaded name; there are actually two max functions.

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

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

Description

Max returns the greater of its two arguments; it returns the first argument if neither is greater than the other.

The two versions of max differ in how they define whether one element is less than another. The first version compares objects using operator<, and the second compares objects using the function object comp.

Definition

Declared in algo.h. The implementation is in algobase.h.

Requirements on types

For the first version:

T is a model of LessThan Comparable.

For the second version:

BinaryPredicate is a model of Binary Predicate.
T is convertible to BinaryPredicate's first argument type and to its second argument type.

Preconditions

Complexity

Example

const int x = max(3, 9);
assert(x == 9);

max