std::max_element

Определён в заголовочном файле `<algorithm>`
template< class ForwardIt > ForwardIt max_element( ForwardIt first, ForwardIt last );	(1)	(constexpr с C++17)
template< class ExecutionPolicy, class ForwardIt > ForwardIt max_element( ExecutionPolicy&& policy, ForwardIt first, ForwardIt last );	(2)	(начиная с C++17)
template< class ForwardIt, class Compare > ForwardIt max_element( ForwardIt first, ForwardIt last, Compare comp );	(3)	(constexpr с C++17)
template< class ExecutionPolicy, class ForwardIt, class Compare > ForwardIt max_element( ExecutionPolicy&& policy, ForwardIt first, ForwardIt last, Compare comp );	(4)	(начиная с C++17)

Находит наибольший элемент в диапазоне [first, last).

1) Элементы сравниваются с помощью operator<(до C++20)std::less{}(начиная с C++20).

3) Элементы сравниваются с помощью функции сравнения comp.

2,4) То же, что и (1,3), но выполняется согласно policy.

Эти перегрузки участвуют в разрешении перегрузки только в том случае, если значение следующего выражения — true:

`std::is_execution_policy_v<std::decay_t<ExecutionPolicy>>`	(до C++20)
`std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>>`	(начиная с C++20)

Параметры

first, last	-	пара итераторов, задающих диапазон проверяемых элементов
policy	-	политика выполнения
comp	-	объект-функция сравнения (то есть объект, удовлетворяющий требованиям Compare), который возвращает `true`, если первый аргумент меньше второго. Сигнатура функции сравнения должна быть эквивалентна следующей: boolcmp(constType1&a,constType2&b); Хотя сигнатура не обязана иметь `const&`, функция не должна изменять переданные ей объекты и должна принимать любые значения типа (возможно, const) `Type1` и `Type2` независимо от категории значения (поэтому `Type1&` не допускается, как и `Type1`, за исключением случая, когда для `Type1` перемещение эквивалентно копированию(начиная с C++11)). Типы Type1 и Type2 должны быть такими, чтобы объект типа ForwardIt можно было разыменовать, а затем неявно преобразовать к каждому из них.
Требования к типам
-`ForwardIt` должен соответствовать требованиям LegacyForwardIterator.

Возвращаемое значение

Итератор на наибольший элемент в диапазоне [first, last). Если несколько элементов диапазона эквивалентны наибольшему элементу, возвращается итератор на первый такой элемент. Если диапазон пуст, возвращается last.

Сложность

Пусть \(\scriptsize N\)N — std::distance(first, last):

1,2) Ровно \(\scriptsize \max(N-1,0)\)max(N-1,0) сравнений с помощью operator<(до C++20)std::less{}(начиная с C++20).

3,4) Ровно \(\scriptsize \max(N-1,0)\)max(N-1,0) вызовов функции сравнения comp.

Исключения

Перегрузки с параметром шаблона с именем ExecutionPolicy сообщают об ошибках следующим образом:

Если при выполнении функции, вызванной в рамках алгоритма, возникает исключение и ExecutionPolicy является одной из стандартных политик, вызывается std::terminate. Для любой другой ExecutionPolicy поведение определяется реализацией.
Если алгоритму не удаётся выделить память, выбрасывается std::bad_alloc.

Возможная реализация

max_element (1)
template<class ForwardIt> ForwardIt max_element(ForwardIt first, ForwardIt last) { if (first == last) return last; ForwardIt largest = first; while (++first != last) if (largest < first) largest = first; return largest; }
max_element (3)
template<class ForwardIt, class Compare> ForwardIt max_element(ForwardIt first, ForwardIt last, Compare comp) { if (first == last) return last; ForwardIt largest = first; while(++first != last) if (comp(largest, first)) largest = first; return largest; }

max_element (1)

template<class ForwardIt>
ForwardIt max_element(ForwardIt first, ForwardIt last)
{
    if (first == last)
        return last;
    
    ForwardIt largest = first;
    
    while (++first != last)
        if (*largest < *first)
            largest = first;
    
    return largest;
}

max_element (3)

template<class ForwardIt, class Compare>
ForwardIt max_element(ForwardIt first, ForwardIt last, Compare comp)
{
    if (first == last)
        return last;
    
    ForwardIt largest = first;
    
    while(++first != last)
        if (comp(*largest, *first))
            largest = first;
    
    return largest;
}

Пример

#include <algorithm>
#include <cmath>
#include <iostream>
#include <vector>

int main()
{
    std::vector<int> v{3, 1, -14, 1, 5, 9, -14, 9};
    std::vector<int>::iterator result;
    
    result = std::max_element(v.begin(), v.end());
    std::cout << "Max element found at index "
              << std::distance(v.begin(), result)
              << " has value " << *result << '\n';
    
    result = std::max_element(v.begin(), v.end(), [](int a, int b)
    {
        return std::abs(a) < std::abs(b);
    });
    std::cout << "Absolute max element found at index "
              << std::distance(v.begin(), result)
              << " has value " << *result << '\n';
}

Вывод:

Max element found at index 5 has value 9
Absolute max element found at index 2 has value -14

Отчёты об ошибках

Следующие отчёты об ошибках, изменяющих поведение, были применены ретроактивно к ранее опубликованным стандартам C++.

DR	Применяется к	Поведение согласно опубликованной версии	Исправленное поведение
LWG 212	C++98	возвращаемое значение не было определено, если `[first,` `last)` пуст	в этом случае возвращается `last`
LWG 2150	C++98	возвращался итератор на первый не наименьший элемент	возвращаемое значение исправлено

См. также

min_element	возвращает наименьший элемент диапазона (шаблон функции и объект-функция алгоритма)
ranges::min_element (C++20)
minmax_element (C++11)	возвращает наименьший и наибольший элементы диапазона (шаблон функции и объект-функция алгоритма)
ranges::minmax_element (C++20)
max	возвращает большее из заданных значений (шаблон функции и объект-функция алгоритма)
ranges::max (C++20)
ranges::max_element (C++20)	возвращает наибольший элемент диапазона (объект-функция алгоритма)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/algorithm/max_element