Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/algorithm/max"

From cppreference.com
< cpp‎ | algorithm
m (→‎Example: adding diversity...)
m (anchors, links.)
Line 3: Line 3:
 
{{dcl begin}}
 
{{dcl begin}}
 
{{dcl header|algorithm}}
 
{{dcl header|algorithm}}
−
{{dcl rev begin|num=1}}
+
{{dcl rev multi|num=1|anchor=1|until1=c++14|dcl1=
−
{{dcl|until=c++14|
+
 
template< class T >  
 
template< class T >  
 
const T& max( const T& a, const T& b );
 
const T& max( const T& a, const T& b );
−
}}
+
|since2=c++14|dcl2=
−
{{dcl|since=c++14|
+
 
template< class T >  
 
template< class T >  
 
constexpr const T& max( const T& a, const T& b );
 
constexpr const T& max( const T& a, const T& b );
 
}}
 
}}
−
{{dcl rev end}}
+
{{dcl rev multi|num=2|anchor=2|until1=c++14|dcl1=
−
{{dcl rev begin|num=2}}
+
−
{{dcl|until=c++14|
+
 
template< class T, class Compare >
 
template< class T, class Compare >
 
const T& max( const T& a, const T& b, Compare comp );
 
const T& max( const T& a, const T& b, Compare comp );
−
}}
+
|since2=c++14|dcl2=
−
{{dcl|since=c++14|
+
 
template< class T, class Compare >
 
template< class T, class Compare >
 
constexpr const T& max( const T& a, const T& b, Compare comp );
 
constexpr const T& max( const T& a, const T& b, Compare comp );
 
}}
 
}}
−
{{dcl rev end}}
+
{{dcl rev multi|num=3|anchor=3|since1=c++11|until1=c++14|dcl1=
−
{{dcl rev begin|num=3}}
+
−
{{dcl|since=c++11|until=c++14|
+
 
template< class T >
 
template< class T >
 
T max( std::initializer_list<T> ilist );
 
T max( std::initializer_list<T> ilist );
−
}}
+
|since2=c++14|dcl2=
−
{{dcl|since=c++14|
+
 
template< class T >
 
template< class T >
 
constexpr T max( std::initializer_list<T> ilist );
 
constexpr T max( std::initializer_list<T> ilist );
 
}}
 
}}
−
{{dcl rev end}}
+
{{dcl rev multi|num=4|anchor=4|since1=c++11|until1=c++14|dcl1=
−
{{dcl rev begin|num=4}}
+
−
{{dcl|since=c++11|until=c++14|
+
 
template< class T, class Compare >
 
template< class T, class Compare >
 
T max( std::initializer_list<T> ilist, Compare comp );
 
T max( std::initializer_list<T> ilist, Compare comp );
−
}}
+
|since2=c++14|dcl2=
−
{{dcl|since=c++14|
+
 
template< class T, class Compare >
 
template< class T, class Compare >
 
constexpr T max( std::initializer_list<T> ilist, Compare comp );
 
constexpr T max( std::initializer_list<T> ilist, Compare comp );
 
}}
 
}}
−
{{dcl rev end}}
 
 
{{dcl end}}
 
{{dcl end}}
  
Line 74: Line 62:
  
 
===Possible implementation===
 
===Possible implementation===
−
{{eq fun
+
{{eq impl
−
|1=
+
|title1=max (1)|ver1=1|1=
 
template<class T>  
 
template<class T>  
 
const T& max(const T& a, const T& b)
 
const T& max(const T& a, const T& b)
Line 81: Line 69:
 
     return (a < b) ? b : a;
 
     return (a < b) ? b : a;
 
}
 
}
−
|2=
+
|title2=max (2)|ver2=2|2=
 
template<class T, class Compare>  
 
template<class T, class Compare>  
 
const T& max(const T& a, const T& b, Compare comp)
 
const T& max(const T& a, const T& b, Compare comp)
Line 87: Line 75:
 
     return (comp(a, b)) ? b : a;
 
     return (comp(a, b)) ? b : a;
 
}
 
}
−
|3=
+
|title3=max (3)|ver3=3|3=
 
template<class T>
 
template<class T>
 
T max(std::initializer_list<T> ilist)
 
T max(std::initializer_list<T> ilist)
Line 93: Line 81:
 
     return *std::max_element(ilist.begin(), ilist.end());
 
     return *std::max_element(ilist.begin(), ilist.end());
 
}
 
}
−
|4=
+
|title4=max (4)|ver4=4|4=
 
template<class T, class Compare>
 
template<class T, class Compare>
 
T max(std::initializer_list<T> ilist, Compare comp)
 
T max(std::initializer_list<T> ilist, Compare comp)
Line 109: Line 97:
 
|code=
 
|code=
 
#include <algorithm>
 
#include <algorithm>
 +
#include <iomanip>
 
#include <iostream>
 
#include <iostream>
 
#include <string_view>
 
#include <string_view>
Line 124: Line 113:
 
               << std::max({010, 10, 0X10, 0B10}) << '\n'
 
               << std::max({010, 10, 0X10, 0B10}) << '\n'
 
               << R"(Longest of "long", "short", and "int" is )"
 
               << R"(Longest of "long", "short", and "int" is )"
−
               << "\"" << std::max({"long", "short", "int"}, longest) << "\"\n";
+
               << std::quoted(std::max({"long", "short", "int"}, longest)) << '\n';
 
}
 
}
 
|output=
 
|output=

Revision as of 09:40, 1 April 2023

 
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.

Overloads (1,3) use operator< to compare the values, overloads (2,4) 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

max (1) 
template<class T> 
const T& max(const T& a, const T& b)
{
    return (a < b) ? b : a;
}
max (2) 
template<class T, class Compare> 
const T& max(const T& a, const T& b, Compare comp)
{
    return (comp(a, b)) ? b : a;
}
max (3) 
template<class T>
T max(std::initializer_list<T> ilist)
{
    return *std::max_element(ilist.begin(), ilist.end());
}
max (4) 
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 <iomanip>
#include <iostream>
#include <string_view>
 
int main()
{
    auto longest = [](const std::string_view s1, const std::string_view s2)
                   {
                       return s1.size() < s2.size();
                   };
 
    std::cout << "Larger of 69 and 96 is " << std::max(69, 96) << "\n"
                 "Larger of 'q', and 'p' is '" << std::max('q', 'p') << "'\n"
                 "Largest of 010, 10, 0X10, and 0B10 is "
              << std::max({010, 10, 0X10, 0B10}) << '\n'
              << R"(Longest of "long", "short", and "int" is )"
              << std::quoted(std::max({"long", "short", "int"}, longest)) << '\n';
}

Output: 

Larger of 69 and 96 is 96
Larger of 'q', and 'p' is 'q'
Largest of 010, 10, 0X10, and 0B10 is 16
Longest of "long", "short", and "int" is "short"

Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR Applied to Behavior as published Correct behavior
LWG 281 C++98 T was required to be CopyConstructible for overloads (1,2) not required

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]
(C++20)
 returns the greater of the given values
(niebloid)[edit]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/algorithm/max&oldid=149925"