std::for_each_n

< cpp‎ | algorithm
 
C++
 
算法库
有制约算法及范围上的算法 (C++20)
有制约算法： std::ranges::copy, std::ranges::sort, ...
执行策略 (C++17)
不修改序列的操作
(C++11)(C++11)(C++11)
for_each_n
(C++17)
修改序列的操作
未初始化存储上的操作
划分操作
排序操作
(C++11)
(C++11)
二分搜索操作
集合操作（在已排序范围上）
堆操作
(C++11)
(C++11)
最小/最大操作
(C++11)
(C++11)
(C++17)

排列
数值运算
C 库
 
定义于头文件 <algorithm>
(1)
template< class InputIt, class Size, class UnaryFunction >
InputIt for_each_n( InputIt first, Size n, UnaryFunction f );
 (C++17 起)
(C++20 前)
template< class InputIt, class Size, class UnaryFunction >
constexpr InputIt for_each_n( InputIt first, Size n, UnaryFunction f );
 (C++20 起)
template< class ExecutionPolicy, class ForwardIt, class Size, class UnaryFunction2 >
ForwardIt for_each_n( ExecutionPolicy&& policy, ForwardIt first, Size n, UnaryFunction2 f );
 (2) (C++17 起)
1) 按顺序应用给定的函数对象 f 到解引用范围 [first, first + n) 中每个迭代器的结果。
2) 应用给定的函数对象 f 到解引用范围 [first, first + n) 中每个迭代器的结果（不必按顺序）。按照 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 才参与重载决议。

对于两种重载，若迭代器是可变的，则 f 可以通过解引用的迭代器修改范围中的元素。若 f 返回结果，则忽略结果。若 n 小于零，则行为未定义。

不同于其余并行算法，不允许 for_each_n 复制序列中的元素，即使它们为可平凡复制。

参数

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

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

 void fun(const Type &a);

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

​

类型要求
-
InputIt 必须满足遗留输入迭代器 (LegacyInputIterator) 的要求。
-
ForwardIt 必须满足遗留向前迭代器 (LegacyForwardIterator) 的要求。
-
UnaryFunction 必须满足可移动构造 (MoveConstructible) 的要求。不必为可复制构造 (CopyConstructible) 。
-
UnaryFunction2 必须满足可复制构造 (CopyConstructible) 的要求。

返回值

first + n

复杂度

正好 n 次应用 f

异常

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

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

可能的实现

参阅 libstdc++ 与 libc++ 中的实现。 

template<class InputIt, class Size, class UnaryFunction>
InputIt for_each_n(InputIt first, Size n, UnaryFunction f)
{
    for (Size i = 0; i < n; ++first, (void) ++i) {
        f(*first);
    }
    return first;
}

示例

运行此代码
#include <algorithm>
#include <iostream>
#include <vector>
 
int main()
{
    std::vector<int> ns{1, 2, 3, 4, 5};
    for (auto n: ns) std::cout << n << ", ";
    std::cout << '\n';
    std::for_each_n(ns.begin(), 3, [](auto& n){ n *= 2; });
    for (auto n: ns) std::cout << n << ", ";
    std::cout << '\n';
}

输出： 

1, 2, 3, 4, 5, 
2, 4, 6, 4, 5,

参阅

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