stdmax_element(3)
std::max_element - std::max_element
Synopsis
Defined in header <algorithm>
template< class ForwardIt > (until C++17)
ForwardIt max_element( ForwardIt first, ForwardIt last );
template< class ForwardIt > (since C++17)
constexpr ForwardIt max_element( ForwardIt first, ForwardIt last );
template< class ExecutionPolicy, class ForwardIt > (2) (since C++17)
ForwardIt max_element( ExecutionPolicy&& policy, ForwardIt first, ForwardIt last ); (1)
template< class ForwardIt, class Compare > (until C++17)
ForwardIt max_element( ForwardIt first, ForwardIt last, Compare comp );
template< class ForwardIt, class Compare > (3) (since C++17)
constexpr ForwardIt max_element( ForwardIt first, ForwardIt last, Compare comp );
template< class ExecutionPolicy, class ForwardIt, class Compare > (4) (since C++17)
ForwardIt max_element( ExecutionPolicy&& policy, ForwardIt first, ForwardIt last, Compare comp );Finds the greatest element in the range [first, last).
- Elements are compared using operator<.
- Elements are compared using the given binary comparison function comp. 2,4) Same as (1,3), but executed according to policy. These overloads do not participate in overload resolution unless std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> is true
Parameters
first, last - forward iterators defining the range to examine
policy - the execution policy to use. See execution_policy for details.
Type requirements
ForwardIt must meet the requirements of LegacyForwardIterator.
Return value
Iterator to the greatest element in the range [first, last). If several elements in the range are equivalent to the greatest element, returns the iterator to the first such element. Returns last if the range is empty.
Complexity
Exactly max(N-1,0) comparisons, where N = std::distance(first, last).
Exceptions
The overloads with a template parameter named ExecutionPolicy report errors as follows:
- If execution of a function invoked as part of the algorithm throws an exception and ExecutionPolicy is one of the standard_policies, std::terminate is called. For any other ExecutionPolicy, the behavior is implementation-defined.
- If the algorithm fails to allocate memory, std::bad_alloc is thrown.
Possible implementation
First version
Second version
Example
// Run this code
#include <algorithm>
#include <iostream>
#include <vector>
#include <cmath>
static bool abs_compare(int a, int b)
{
return (std::abs(a) < std::abs(b));
}
int main()
{
std::vector<int> v{3, 1, -14, 1, 5, 9};
std::vector<int>::iterator result;
result = std::max_element(v.begin(), v.end());
std::cout << "max element at: " << std::distance(v.begin(), result) << ‘\n’;
result = std::max_element(v.begin(), v.end(), abs_compare);
std::cout << "max element (absolute) at: " << std::distance(v.begin(), result);
}
Output:
See also