std::max_element

来自cppreference.com
< cpp‎ | algorithm
 
 
算法库
受约束算法及范围上的算法 (C++20)
受约束算法: std::ranges::copy, std::ranges::sort, ...
执行策略 (C++17)
不修改序列的操作
(C++11)(C++11)(C++11)
(C++17)
修改序列的操作
Partitioning operations
划分操作
排序操作
(C++11)
二分搜索操作
集合操作(在已排序范围上)
堆操作
(C++11)
最小/最大操作
max_element
(C++11)
(C++17)

排列
数值运算
未初始化存储上的操作
(C++17)
(C++17)
(C++17)
C 库
 
在标头 <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>>

(C++20 前)

std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>>

(C++20 起)
true 时才会参与重载决议。

参数

first, last - 定义要检验范围的向前迭代器
policy - 所用的执行策略。细节见执行策略
comp - 比较函数对象(即满足比较 (Compare) 要求的对象),如果首个参数小于 第二个,那么返回 ​true

比较函数的签名应等价于如下:

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

虽然签名不必有 const &,函数也不能修改传递给它的对象,而且必须接受(可有 const 限定的)类型 Type1Type2 的值,与值类别无关(从而不允许 Type1 &,也不允许 Type1,除非 Type1 的移动等价于复制 (C++11 起))。
类型 Type1Type2 必须使得 ForwardIt 类型的对象能在解引用后隐式转换到这两个类型。 ​

类型要求
-
ForwardIt 必须符合老式向前迭代器 (LegacyForwardIterator) 的要求。

返回值

指向范围 [first, last) 中最大元素的迭代器。如果范围中有多个元素等价于最大元素,那么返回指向首个这种元素的迭代器。范围为空时返回 last

复杂度

准确比较 max(N-1,0) 次,其中 N = std::distance(first, last)

异常

拥有名为 ExecutionPolicy 的模板形参的重载按下列方式报告错误:

  • 如果作为算法一部分调用的函数的执行抛出异常,且 ExecutionPolicy标准策略之一,那么调用 std::terminate。对于任何其他 ExecutionPolicy,行为由实现定义。
  • 如果算法无法分配内存,那么抛出 std::bad_alloc

可能的实现

版本一
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;
}
版本二
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 <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 << "最大元素位于:"
              << std::distance(v.begin(), result) << '\n';
 
    result = std::max_element(v.begin(), v.end(), abs_compare);
    std::cout << "(绝对值)最大元素位于:"
              << std::distance(v.begin(), result) << '\n';
}

输出:

最大元素位于:5
(绝对值)最大元素位于:2

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告 应用于 出版时的行为 正确行为
LWG 212 C++98 first == last 时未指明返回值 此时返回 last

参阅

返回范围内的最小元素
(函数模板)
返回范围内的最小元素和最大元素
(函数模板)
返回各给定值中的较大者
(函数模板)