std::inclusive_scan

在头文件 `<numeric>` 中定义
template< class InputIt, class OutputIt > OutputIt inclusive_scan( InputIt first, InputIt last, OutputIt d_first );	(1)	(自 C++17 起) (自 C++20 起为 constexpr)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2 > ForwardIt2 inclusive_scan( ExecutionPolicy&& policy, ForwardIt1 first, ForwardIt1 last, ForwardIt2 d_first );	(2)	(自 C++17 起)
template< class InputIt, class OutputIt, class BinaryOp > OutputIt inclusive_scan( InputIt first, InputIt last, OutputIt d_first, BinaryOp op );	(3)	(自 C++17 起) (自 C++20 起为 constexpr)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2, class BinaryOp > ForwardIt2 inclusive_scan( ExecutionPolicy&& policy, ForwardIt1 first, ForwardIt1 last, ForwardIt2 d_first, BinaryOp op );	(4)	(自 C++17 起)
template< class InputIt, class OutputIt, class BinaryOp, class T > OutputIt inclusive_scan( InputIt first, InputIt last, OutputIt d_first, BinaryOp op, T init );	(5)	(自 C++17 起) (自 C++20 起为 constexpr)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2, class BinaryOp, class T > ForwardIt2 inclusive_scan( ExecutionPolicy&& policy, ForwardIt1 first, ForwardIt1 last, ForwardIt2 d_first, BinaryOp op, T init );	(6)	(自 C++17 起)

1) 等效于 inclusive_scan(first, last, d_first, std::plus<>().

3) 使用 op 计算包含的前缀和。

对于 [0, std::distance(first, last)) 中的每个整数 i，按以下顺序执行以下操作

创建一个序列，该序列按顺序由 [first, iter] 中的元素组成，其中 iter 是 first 的下一个 i 个迭代器
th 。
计算序列在 op 上的广义非交换和。
将结果分配给 *dest，其中 dest 是 d_first 的下一个 i 个迭代器
th 。

5) 与 (3) 相同，但创建的每个序列都由 init 以及 [first, iter] 中的元素按顺序组成。

2,4,6) 与 (1,3,5) 相同，但根据 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 开始)

一组元素在二元运算符 binary_op 上的 广义非交换和 定义如下：

如果序列只有一个元素，则和为该元素的值。
否则，按以下顺序执行以下操作：

从序列中选择任意两个相邻元素 elem1 和 elem2。
计算 binary_op(elem1, elem2) 并用结果替换序列中的两个元素。
重复步骤 1 和 2，直到序列中只有一个元素。

给定 binary_op 作为实际的二元运算符

如果 binary_op 不是结合的（例如浮点加法），则结果是非确定性的。

对于重载 (1-4)，如果 binary_op(*first, *first) 不能转换为 decltype(first) 的值类型，则程序格式错误。

对于重载 (5,6)，如果以下任何值不能转换为 T，则程序格式错误：

binary_op(init, *first)
binary_op(init, init)
binary_op(*first, *first)

如果满足以下任何条件，则行为未定义：

对于重载 (1-4)，decltype(first) 的值类型不是可移动构造。
对于重载 (5,6)，T 不是可移动构造。
binary_op 修改 [first, last) 中的任何元素。
binary_op 使 [first, last] 中的任何迭代器或子范围失效。

[编辑] 参数

first, last	-	要累加的元素范围
d_first	-	目标范围的起点；可以等于 first
policy	-	要使用的执行策略。有关详细信息，请参阅执行策略。
init	-	初始值
op	-	二元函数对象，它将应用于对输入迭代器解引用结果、其他 op 的结果以及 init（如果提供）的结果。
类型要求
- `InputIt` 必须满足传统输入迭代器的要求。
- `OutputIt` 必须满足传统输出迭代器的要求。
- `ForwardIt1, ForwardIt2` 必须满足传统前向迭代器的要求。

[编辑] 返回值

指向写入的最后一个元素之后的元素的迭代器。

[编辑] 复杂度

给定 $\scriptsize N$ $N$ 作为 std::distance(first, last)

1,2)

O(N)

次 std::plus<>() 应用。

3-6)

O(N)

次 op 应用。

[编辑] 异常

带有名为 ExecutionPolicy 的模板参数的重载报告错误如下：

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

[编辑] 示例

运行此代码

#include <functional>
#include <iostream>
#include <iterator>
#include <numeric>
#include <vector>
 
int main()
{
    std::vector data{3, 1, 4, 1, 5, 9, 2, 6};
 
    std::cout << "Exclusive sum: ";
    std::exclusive_scan(data.begin(), data.end(),
                        std::ostream_iterator<int>(std::cout, " "),
                        0);
 
    std::cout << "\nInclusive sum: ";
    std::inclusive_scan(data.begin(), data.end(),
                        std::ostream_iterator<int>(std::cout, " "));
 
    std::cout << "\n\nExclusive product: ";
    std::exclusive_scan(data.begin(), data.end(),
                        std::ostream_iterator<int>(std::cout, " "),
                        1, std::multiplies<>{});
 
    std::cout << "\nInclusive product: ";
    std::inclusive_scan(data.begin(), data.end(),
                        std::ostream_iterator<int>(std::cout, " "),
                        std::multiplies<>{});
}

输出

Exclusive sum: 0 3 4 8 9 14 23 25
Inclusive sum: 3 4 8 9 14 23 25 31
 
Exclusive product: 1 3 3 12 12 60 540 1080
Inclusive product: 3 3 12 12 60 540 1080 6480

[编辑] 另请参阅

adjacent_difference	计算范围中相邻元素之间的差异 (函数模板) [编辑]
accumulate	将范围内的元素累加或折叠 (函数模板) [编辑]
partial_sum	计算元素范围的偏和 (函数模板) [编辑]
transform_inclusive_scan (C++17)	应用可调用对象，然后计算包含扫描 (函数模板) [编辑]
exclusive_scan (C++17)	类似于 std::partial_sum，从 $i$ ^th 和中排除 $i$ ^th 输入元素 (函数模板) [编辑]

编译器支持
独立和托管
语言
标准库
标准库头文件
命名要求
特性测试宏 (C++20)
语言支持库
概念库 (C++20)
元编程库 (C++11)
诊断库
通用实用程序库
字符串库
容器库
迭代器库
范围库 (C++20)
算法库
数值库
本地化库
输入/输出库
文件系统库 (C++17)
正则表达式库 (C++11)
并发支持库 (C++11)
执行支持库 (C++26)
技术规范
符号索引
外部库

cppreference.com

命名空间

变体

视图

操作