std::for_each_n - cppreference.com

std::for_each_n

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

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

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

1) 从 first 开始按顺序应用 f。
如果 UnaryFunc 不可移动构造 (MoveConstructible) ，那么行为未定义。
2) 不一定按顺序应用 f。按照 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 起)
如果 UnaryFunc 不可复制构造 (CopyConstructible) ，那么行为未定义。

如果 n >= 0 不是 true，那么行为未定义。

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

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

参数

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

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

void fun(const Type &a);

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

​

类型要求
-
InputIt 必须满足老式输入迭代器 (LegacyInputIterator) 。
-
ForwardIt 必须满足老式向前迭代器 (LegacyForwardIterator) 。
-
Size 必须可转换到整数类型。

返回值

等于 first + n 的迭代器，或更正式的，等于 std::advance(first, n) 的迭代器。

复杂度

应用 n 次 f。

异常

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

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

可能的实现

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

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

示例

运行此代码
#include <algorithm>
#include <iostream>
#include <vector>

void println(auto const& v)
{
    for (auto count{v.size()}; const auto& e : v)
        std::cout << e << (--count ? ", " : "\n");
}

int main()
{
    std::vector<int> vi{1, 2, 3, 4, 5};
    println(vi);
    
    std::for_each_n(vi.begin(), 3, [](auto& n) { n *= 2; });
    println(vi);
}

输出： 

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

参阅