Spec-Zone.ru › C++

std::max_element

Определено в заголовочном файле <algorithm>
(1)
template< class ForwardIt > 
ForwardIt max_element( ForwardIt first, ForwardIt last );
(до C++17)
template< class ForwardIt > 
constexpr ForwardIt max_element( ForwardIt first, ForwardIt last );
(с C++17)
template< class ExecutionPolicy, class ForwardIt > 
ForwardIt max_element( ExecutionPolicy&& policy,
                       ForwardIt first, ForwardIt last );
(2) (с C++17)
(3)
template< class ForwardIt, class Compare >
ForwardIt max_element( ForwardIt first, ForwardIt last, Compare comp );
(до C++17)
template< class ForwardIt, class Compare >
constexpr ForwardIt max_element( ForwardIt first, ForwardIt last,
                                 Compare comp );
(с 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<.
3) Элементы сравниваются с использованием заданной двоичной функции сравнения comp.
2,4) То же, что и (1,3), но выполняется в соответствии с policy. Эти перегрузки не участвуют в разрешении перегрузки, если

std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> является true.

(до C++20)

std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> является true.

(с C++20)

Параметры

first, last - итераторы, определяющие диапазон для проверки
policy - политика выполнения. Подробнее см. в политике выполнения.
comp - объект-функция сравнения (т.е. объект, удовлетворяющий требованиям Compare), который возвращает true если первый аргумент меньше второго.

Подпись функции сравнения должна быть эквивалентна следующей:

bool cmp(const Type1& a, const Type2& b);

Хотя подпись не должна содержать const&, функция не должна изменять объекты, переданные ей, и должна быть способна принимать все значения типа (возможно, const) Type1 и Type2 независимо от категории значения (следовательно, Type1& недопустимо, а также Type1 за исключением случаев, когда для Type1 перемещение эквивалентно копированию(с C++11)).
Типы Type1 и Type2 должны быть такими, чтобы объект типа ForwardIt мог быть разыменован и затем неявным образом преобразован в оба из них.

Требования к типу
-ForwardIt должен удовлетворять требованиям LegacyForwardIterator.

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

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

Сложность

Ровно max(N-1,0) сравнений, где N = std::distance(first, last).

Исключения

Перегрузки с параметром шаблона под названием 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;
    ++first;
 
    for (; first != last; ++first)
        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;
    ++first;
 
    for (; first != last; ++first)
        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}; 
    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 в этом случае

См. также

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

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API