std::for_each_n

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏(C++20)

语言支持库

概念库(C++20)

诊断库

内存管理库

元编程库(C++11)

通用工具库

容器库

迭代器库

范围库(C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库(C++17)

并发支持库(C++11)

执行控制库(C++26)

技术规范

符号索引

外部库

 

算法库

受约束算法及范围上的算法(C++20)
包含算法例如 ranges::copy, ranges::sort, ...
执行策略 (C++17)
is_execution_policy (C++17)   execution::seqexecution::parexecution::par_unseqexecution::unseq (C++17)    (C++17)(C++17)(C++20)	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policyexecution::parallel_unsequenced (C++17)(C++17)(C++17)(C++20)
不修改序列的操作 批量操作 for_each for_each_n (C++17) 搜索操作 all_ofany_ofnone_of (C++11)                   (C++11)(C++11) countcount_if mismatch equal findfind_iffind_if_not (C++11) find_end find_first_of adjacent_find search search_n 修改序列的操作 复制操作 copycopy_if (C++11) copy_backward copy_n (C++11) move (C++11) move_backward (C++11) 交换操作 swap iter_swap swap_ranges 变换操作 replacereplace_if transform replace_copyreplace_copy_if 生成操作 fill fill_n generate generate_n 移除操作 removeremove_if unique remove_copyremove_copy_if unique_copy 顺序变更操作 reverse reverse_copy rotate rotate_copy random_shuffleshuffle (C++17 前)(C++11) shift_leftshift_right (C++20)(C++20) 采样操作 sample (C++17)	排序和相关操作 划分操作 partition partition_copy (C++11)   stable_partition is_partitioned (C++11) partition_point (C++11) 排序操作 sort stable_sort partial_sort partial_sort_copy is_sorted (C++11) is_sorted_until (C++11) nth_element 二分搜索操作（在已划分范围上） lower_bound upper_bound equal_range binary_search 集合操作（在有序范围上） includes set_union set_intersection set_difference set_symmetric_difference 归并操作（在有序范围上） merge inplace_merge 堆操作 push_heap pop_heap make_heap sort_heap is_heap (C++11) is_heap_until (C++11) 最小/最大操作 max min minmax (C++11) clamp (C++17) max_element min_element minmax_element (C++11) 字典序比较操作 lexicographical_compare lexicographical_compare_three_way (C++20) 排列操作 next_permutation prev_permutation is_permutation (C++11) C 库 qsort bsearch
数值运算
iota (C++11)                        inner_product adjacent_difference accumulate reduce (C++17) transform_reduce (C++17)	partial_sum inclusive_scan (C++17)   exclusive_scan (C++17) transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)
在未初始化内存上的操作
uninitialized_copy uninitialized_move (C++17)    uninitialized_fill uninitialized_copy_n (C++11) uninitialized_move_n (C++17) uninitialized_fill_n	destroy (C++17) destroy_n (C++17) destroy_at (C++17) construct_at (C++20)      uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17)

 

在标头 <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(autoconst& v){for(auto count{v.size()};constauto& 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

参阅

transform	应用函数到元素范围，并在目标范围存储结果 (函数模板)
范围 for 循环(C++11)	执行范围上的循环
for_each	应用一元函数对象到范围中元素 (函数模板)
ranges::for_each_n (C++20)	应用函数对象到序列的前 N 个元素 (算法函数对象)