Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/algorithm/max"

From cppreference.com
< cpp‎ | algorithm
m ('min'✀'max')
m (add an initialization list example with multiple numbers to provide an example of form (3))
Line 111: Line 111:
 
#include <iostream>
 
#include <iostream>
 
#include <string_view>
 
#include <string_view>
−
 
+
 
int main()
 
int main()
 
{
 
{
 
     std::cout << "larger of 1 and 9999 is " << std::max(1, 9999) << '\n'
 
     std::cout << "larger of 1 and 9999 is " << std::max(1, 9999) << '\n'
 
               << "larger of 'a', and 'b' is '" << std::max('a', 'b') << "'\n"
 
               << "larger of 'a', and 'b' is '" << std::max('a', 'b') << "'\n"
 +
              << "largest of 1, 10, 50, and 200 is " << std::max({1, 10, 50, 200}) << '\n'
 
               << "longest of \"foo\", \"bar\", and \"hello\" is \""
 
               << "longest of \"foo\", \"bar\", and \"hello\" is \""
 
               << std::max({ "foo", "bar", "hello" },
 
               << std::max({ "foo", "bar", "hello" },
Line 125: Line 126:
 
larger of 1 and 9999 is 9999
 
larger of 1 and 9999 is 9999
 
larger of 'a', and 'b' is 'b'
 
larger of 'a', and 'b' is 'b'
 +
largest of 1, 10, 50, and 200 is 200
 
longest of "foo", "bar", and "hello" is "hello"
 
longest of "foo", "bar", and "hello" is "hello"
 
}}
 
}}

Revision as of 13:54, 30 November 2020

 
C++
 
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)
(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
max
(C++11)
(C++17)
Lexicographical comparison operations
(C++20)
Permutation operations
C library
Numeric operations
Operations on uninitialized memory
 
Defined in header <algorithm>
(1)
template< class T >
const T& max( const T& a, const T& b );
 (until C++14)
template< class T >
constexpr const T& max( const T& a, const T& b );
 (since C++14)
(2)
template< class T, class Compare >
const T& max( const T& a, const T& b, Compare comp );
 (until C++14)
template< class T, class Compare >
constexpr const T& max( const T& a, const T& b, Compare comp );
 (since C++14)
(3)
template< class T >
T max( std::initializer_list<T> ilist );
 (since C++11)
(until C++14)
template< class T >
constexpr T max( std::initializer_list<T> ilist );
 (since C++14)
(4)
template< class T, class Compare >
T max( std::initializer_list<T> ilist, Compare comp );
 (since C++11)
(until C++14)
template< class T, class Compare >
constexpr T max( std::initializer_list<T> ilist, Compare comp );
 (since C++14)

Returns the greater of the given values.

1-2) Returns the greater of a and b.
3-4) Returns the greatest 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
comp - comparison function object (i.e. an object that satisfies the requirements of Compare) which returns true 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 in order to use overloads (1,3).
-
T must meet the requirements of CopyConstructible in order to use overloads (3,4).

Return value

1-2) The greater of a and b. If they are equivalent, returns a.
3-4) The greatest value in ilist. If several values are equivalent to the greatest, returns the leftmost one.

Complexity

1-2) Exactly one comparison
3-4) Exactly ilist.size() - 1 comparisons

Possible implementation

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

Notes

Capturing the result of std::max by reference produces a dangling reference if one of the parameters is a temporary and that parameter is returned: 

int n = -1;
const int& r = std::max(n + 2, n * 2); // r is dangling

Example

Run this code
#include <algorithm>
#include <iostream>
#include <string_view>
 
int main()
{
    std::cout << "larger of 1 and 9999 is " << std::max(1, 9999) << '\n'
              << "larger of 'a', and 'b' is '" << std::max('a', 'b') << "'\n"
              << "largest of 1, 10, 50, and 200 is " << std::max({1, 10, 50, 200}) << '\n'
              << "longest of \"foo\", \"bar\", and \"hello\" is \""
              << std::max({ "foo", "bar", "hello" },
                          [](const std::string_view s1, const std::string_view s2) {
                              return s1.size() < s2.size();
                          }) << "\"\n";
}

Output: 

larger of 1 and 9999 is 9999
larger of 'a', and 'b' is 'b'
largest of 1, 10, 50, and 200 is 200
longest of "foo", "bar", and "hello" is "hello"

See also

 returns the smaller of the given values
(function template) [edit]
(C++11)
 returns the smaller and larger of two elements
(function template) [edit]
returns the largest element in a range
(function template) [edit]
(C++17)
 clamps a value between a pair of boundary values
(function template) [edit]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/algorithm/max&oldid=124635"