◐ Shell
clean mode source ↗

std::for_each - cppreference.com

来自cppreference.com

在标头 <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 起)

对目标范围 [first, last) 中的每个元素应用给定的可调用对象 f。忽略 f 返回的结果。

2) 不一定按顺序应用 f。按照 policy 执行算法。

与其他并行算法不同，for_each 不能任意复制目标范围中的元素。

此重载只有在以下表达式的值是 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 - 表示目标范围的迭代器对
f - 函数对象，会应用到元素

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

void fun(const Type &a);

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

policy - 所用的执行策略
类型要求
-InputIt 必须满足老式输入迭代器 (LegacyInputIterator) 。
-ForwardIt 必须满足老式向前迭代器 (LegacyForwardIterator) 。

返回值

1) f

复杂度

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

异常

2) 在执行过程中：

  • 如果并行化所需的临时内存资源不可用，那么就会抛出 std::bad_alloc。
  • 如果在通过算法实参访问对象时抛出了未捕获的异常，那么行为由执行策略决定（标准策略会调用 std::terminate）。

注解

如果迭代器类型（InputIt/ForwardIt）是可变的，那么 f 可以修改目标范围中的元素。

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

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

可能的实现

参阅 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 起隐式移动
}

示例

下列示例代码用 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 个元素
(函数模板 & 算法函数对象)[编辑]
应用函数到元素范围，并在目标范围存储结果
(函数模板 & 算法函数对象)[编辑]
范围 for 循环 (C++11) 执行范围上的循环[编辑]