C++

Reference

function template

std::max

default (1)
template  const T& max (const T& a, const T& b);
custom (2)
template   const T& max (const T& a, const T& b, Compare comp);
default (1)
template  const T& max (const T& a, const T& b);
custom (2)
template   const T& max (const T& a, const T& b, Compare comp);
initializer list (3)
template  T max (initializer_list il);template   T max (initializer_list il, Compare comp);
default (1)
template  constexpr const T& max (const T& a, const T& b);
custom (2)
template   constexpr const T& max (const T& a, const T& b, Compare comp);
initializer list (3)
template  constexpr T max (initializer_list il);template   constexpr T max (initializer_list il, Compare comp);
Return the largest
Returns the largest of a and b. If both are equivalent, a is returned.

The versions for initializer lists (3) return the largest of all the elements in the list. Returning the first of them if these are more than one.

The function uses operator< (or comp, if provided) to compare the values.

The behavior of this function template (C++98) is equivalent to:
1
2
3
 
template <class T> const T& max (const T& a, const T& b) {
  return (a// or: return comp(a,b)?b:a; for version (2)
}

Parameters

a, b
Values to compare.
comp
Binary function that accepts two values of type T as arguments, and returns a value convertible to bool. The value returned indicates whether the element passed as first argument is considered less than the second.
The function shall not modify any of its arguments.
This can either be a function pointer or a function object.
il
An initializer_list object.
These objects are automatically constructed from initializer list declarators.

T shall support being compared with operator<.
T shall be copy constructible.
For (3), T shall be copy constructible.

Return value

The largest of the values passed as arguments.

Example

1
2
3
4
5
6
7
8
9
10
11
 
// max example
#include      // std::cout
#include     // std::max

int main () {
  std::cout << "max(1,2)==" << std::max(1,2) << '\n';
  std::cout << "max(2,1)==" << std::max(2,1) << '\n';
  std::cout << "max('a','z')==" << std::max('a','z') << '\n';
  std::cout << "max(3.14,2.73)==" << std::max(3.14,2.73) << '\n';
  return 0;
}

Output:
max(1,2)==2
max(2,1)==2
max('a','z')==z
max(3.14,2.73)==3.14


Complexity

Linear in one less than the number of elements compared (constant for (1) and (2)).

Exceptions

Throws if any comparison throws.
Note that invalid arguments cause undefined behavior.

See also

min
Return the smallest (function template)
max_element
Return largest element in range (function template)