std::for_each

来自cppreference.com
< cpp‎ | algorithm
 
 
算法库
受约束算法及范围上的算法 (C++20)
包含算法例如 ranges::copy, ranges::sort, ...
执行策略 (C++17)
排序和相关操作
划分操作
排序操作
二分搜索操作(在已划分范围上)
集合操作(在有序范围上)
归并操作(在有序范围上)
堆操作
最小/最大操作
(C++11)
(C++17)
字典序比较操作
排列操作
C 库

数值运算
(C++11)                       
在未初始化内存上的操作
 
在标头 <algorithm> 定义
template< class InputIt, class UnaryFunc >
UnaryFunc for_each( InputIt first, InputIt last, UnaryFunc f );
(1) (C++20 起为 constexpr)
template< class ExecutionPolicy, class ForwardIt, class UnaryFunc >

void for_each( ExecutionPolicy&& policy,

               ForwardIt first, ForwardIt last, UnaryFunc f );
(2) (C++17 起)

对范围 [firstlast) 中每个迭代器的解引用结果应用给定的函数对象 f。忽略 f 返回的结果。

1)first 开始按顺序应用 f

如果 UnaryFunc可移动构造 (MoveConstructible) ,那么行为未定义。

(C++11 起)
2) 不一定按顺序应用 f。按照 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 时时才会参与重载决议。
如果 UnaryFunc可复制构造 (CopyConstructible) ,那么行为未定义。

如果迭代器类型(InputIt/ForwardIt)是可变的,那么 f 可以通过解引用后的迭代器修改范围的元素。

与其他并行算法不同,不允许 for_each 复制序列中的元素,即使它们可平凡复制 (TriviallyCopyable)

参数

first, last - 要应用函数到的范围
policy - 所用的执行策略。细节见执行策略
f - 函数对象,要应用到解引用范围 [firstlast) 中每个迭代器结果的函数

函数签名应当等价于如下者:

 void fun(const Type &a);

签名不必拥有 const &
类型  Type 必须使得 InputIt 类型对象能在解引用后隐式转换到  Type

类型要求
-
InputIt 必须满足老式输入迭代器 (LegacyInputIterator)
-
ForwardIt 必须满足老式向前迭代器 (LegacyForwardIterator)

返回值

1) f
2) (无)

复杂度

应用 std::distance(first, last)f

异常

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

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

可能的实现

参阅 libstdc++libc++MSVC stdlib 中的实现。

template<class InputIt, class UnaryFunc>
constexpr UnaryFunc for_each(InputIt first, InputIt last, UnaryFunc f)
{
    for (; first != last; ++first)
        f(*first);
 
    return f; // C++11 起隐式移动
}

注解

对于重载 (1)f 可以是带状态的函数对象。返回值可以视为批量操作的最终状态。

对于重载 (2),可能会由于需要进行并行调用而创建 f 的多个副本。因为并行操作会阻碍高效的状态累积,所以不会返回任何值。

示例

下列示例代码用 lambda 表达式自增 vector 的所有元素,然后用函数对象中重载的 operator() 计算它们的和。注意推荐用更适合的算法 std::accumulate 计算和。

#include <algorithm>
#include <iostream>
#include <vector>
 
int main()
{
    std::vector<int> v{3, -4, 2, -8, 15, 267};
 
    auto print = [](const int& n) { std::cout << n << ' '; };
 
    std::cout << "之前:";
    std::for_each(v.cbegin(), v.cend(), print);
    std::cout << '\n';
 
    // 就地自增每个元素
    std::for_each(v.begin(), v.end(), [](int &n){ n++; });
 
    std::cout << "之后:";
    std::for_each(v.cbegin(), v.cend(), print);
    std::cout << '\n';
 
    struct Sum
    {
        void operator()(int n) { sum += n; }
        int sum {0};
    };
 
    // 对每个元素调用 Sum::operator()
    Sum s = std::for_each(v.begin(), v.end(), Sum());
    std::cout << "总和:" << s.sum << '\n';
}

输出:

之前:3 -4 2 -8 15 267 
之后:4 -3 3 -7 16 268 
总和:281

缺陷报告

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

缺陷报告 应用于 出版时的行为 正确行为
LWG 475 C++98 不明确 f 是否可以修改遍历中的序列的元素
for_each 被归类为“不修改序列的操作”)
使之明确(迭代器
类型可变时允许)
LWG 2747 C++11 重载 (1) 返回 std::move(f) 返回 f(它会隐式移动)

参阅

将一个函数应用于某一范围的各个元素,并在目标范围存储结果
(函数模板)
应用一个函数对象到序列的前 n 个元素
(函数模板)
应用函数到范围中的元素
(niebloid)
应用函数对象到序列的前 n 个元素
(niebloid)
范围 for 循环(C++11) 执行范围上的循环