来自cppreference.com
| 在标头 <algorithm> 定义
|
||
| 调用签名 |
||
template< std::input_iterator I, std::sentinel_for<I> S,
class Proj = std::identity,
std::indirectly_unary_invocable<std::projected<I, Proj>> Fun >
constexpr for_each_result<I, Fun>
for_each( I first, S last, Fun f, Proj proj = {} );
|
(1) | (C++20 起) |
template< ranges::input_range R, class Proj = std::identity,
std::indirectly_unary_invocable<
std::projected<ranges::iterator_t<R>, Proj>> Fun >
constexpr for_each_result<ranges::borrowed_iterator_t<R>, Fun>
for_each( R&& r, Fun f, Proj proj = {} );
|
(2) | (C++20 起) |
template< /*execution-policy*/ Ep, std::random_access_iterator I,
std::sized_sentinel_for<I> S, class Proj = std::identity,
std::indirectly_unary_invocable<std::projected<I, Proj>> Fun >
I for_each( Ep&& policy, I first, S last, Fun f, Proj proj = {} );
|
(3) | (C++26 起) |
template< /*execution-policy*/ Ep,
/*sized-random-access-range*/ R, class Proj = std::identity,
std::indirectly_unary_invocable
<std::projected<ranges::iterator_t<R>, Proj>> Fun >
ranges::borrowed_iterator_t<R>
for_each( Ep&& policy, R&& r, Fun f, Proj proj = {} );
|
(4) | (C++26 起) |
| 辅助类型 |
||
template< class I, class F >
using for_each_result = ranges::in_fun_result<I, F>;
|
(5) | (C++20 起) |
/*execution-policy*/ 的定义见此页;/*sized-random-access-range*/ 的定义见此页。
对目标范围 [first, last) 或 r 中的每个(以 proj 投影后的)元素应用给定的可调用对象 f。忽略 f 返回的结果。
1,2) 从目标范围开头开始按顺序应用
f。3,4) 不一定按顺序应用
f。按照 policy 执行算法。 与其他并行算法不同,
for_each 不能任意复制目标范围中的元素。此页面上描述的函数式实体是算法函数对象(非正式地称为 niebloid),即:
参数
| first, last | - | 表示目标范围的迭代器对 |
| r | - | 目标范围 |
| f | - | 会应用到(投影后的)元素的可调用对象 |
| proj | - | 会应用到元素的投影 |
| policy | - | 所用的执行策略 |
返回值
1)
{last, std::move(f)}2) 在
R 实现 forward_range 时返回 {ranges::next(ranges::begin(r), ranges::end(r)), std::move(f)},否则返回 (C++26 起){ranges::end(r), std::move(f)}3)
last4) 在
R 实现 forward_range 时返回 ranges::next(ranges::begin(r), ranges::end(r)),否则返回 (C++26 起)ranges::end(r)复杂度
1,3) 应用
ranges::distance(first, last) 次 f 和 proj。2,4) 应用
ranges::distance(r) 次 f 和 proj。异常
3,4) 在执行过程中:
- 如果并行化所需的临时内存资源不可用,那么就会抛出 std::bad_alloc。
- 如果在通过算法实参访问对象时抛出了未捕获的异常,那么行为由执行策略决定(标准策略会调用 std::terminate)。
注解
如果投影返回了可变引用,那么 f 可以修改目标范围中的元素。
对于重载 (1,2),f 可以是带状态的可调用对象。返回值中的可调用对象可以视为批量操作的最终状态。
对于重载 (3,4),可能会由于需要进行并行调用而创建 f 的多个副本。因为并行操作会阻碍高效的状态累积,所以任何值中不会包含可调用对象。
可能的实现
struct for_each_fn
{
template<std::input_iterator I, std::sentinel_for<I> S, class Proj = std::identity,
std::indirectly_unary_invocable<std::projected<I, Proj>> Fun>
constexpr ranges::for_each_result<I, Fun>
operator()(I first, S last, Fun f, Proj proj = {}) const
{
for (; first != last; ++first)
std::invoke(f, std::invoke(proj, *first));
return {std::move(first), std::move(f)};
}
template<ranges::input_range R, class Proj = std::identity,
std::indirectly_unary_invocable<std::projected<ranges::iterator_t<R>,
Proj>> Fun>
constexpr ranges::for_each_result<ranges::borrowed_iterator_t<R>, Fun>
operator()(R&& r, Fun f, Proj proj = {}) const
{
return (*this)(ranges::begin(r), ranges::end(r), std::move(f), std::ref(proj));
}
template<ranges::forward_range R, class Proj = std::identity,
std::indirectly_unary_invocable
<std::projected<ranges::iterator_t<R>, Proj>> Fun>
constexpr ranges::for_each_result<ranges::borrowed_iterator_t<R>, Fun>
operator()(R&& r, Fun f, Proj proj = {}) const
{
return (*this)(ranges::begin(r),
ranges::next(ranges::begin(r), ranges::end(r)),
std::move(f), std::ref(proj));
}
};
inline constexpr for_each_fn for_each;
|
示例
以下示例用 lambda 表达式递增 vector 所有的元素,然后用函数对象中重载的 operator() 计算它们的和。注意,要计算总和的话,建议使用专用的算法 std::accumulate。
运行此代码
#include <algorithm>
#include <cassert>
#include <iostream>
#include <string>
#include <utility>
#include <vector>
struct Sum
{
void operator()(int n) { sum += n; }
int sum{0};
};
int main()
{
namespace ranges = std::ranges;
std::vector<int> nums {3, 4, 2, 8, 15, 267};
auto print = [](const auto& n) { std::cout << ' ' << n; };
std::cout << "之前:";
ranges::for_each(std::as_const(nums), print);
print('\n');
ranges::for_each(nums, [](int& n) { ++n; });
// 对每个数调用 Sum::operator()
auto [i, s] = ranges::for_each(nums.begin(), nums.end(), Sum());
assert(i == nums.end());
std::cout << "之后:";
ranges::for_each(nums.cbegin(), nums.cend(), print);
std::cout << "\n" "总和: " << s.sum << '\n';
using pair = std::pair<int, std::string>;
std::vector<pair> pairs {{1,"one"}, {2,"two"}, {3,"tree"}};
std::cout << "投影 pair::first: ";
ranges::for_each(pairs, print, [](const pair& p) { return p.first; });
std::cout << "\n" "投影 pair::second:";
ranges::for_each(pairs, print, &pair::second);
print('\n');
}
输出:
之前: 3 4 2 8 15 267
之后: 4 5 3 9 16 268
总和: 305
投影 pair::first: 1 2 3
投影 pair::second: one two tree
参阅
| 应用一元函数对象到范围中的元素 (函数模板) | |
(C++20) |
应用函数对象到序列的前 N 个元素 (算法函数对象) |
(C++20) |
应用函数到元素范围 (算法函数对象) |
范围 for 循环 (C++11)
|
执行范围上的循环 |