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 个迭代器。
计算该序列在 op 下的广义非交换和。
将计算结果赋给 *dest，其中 dest 是 d_first 的下 i 个迭代器。

5) 同 (3)，但创建的每个序列以 init 开始，然后按顺序后随 [first, iter] 中的所有元素。

2,4,6) 同 (1,3,5)，但按照 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 时时才会参与重载决议。

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

如果序列只有一个元素，那么和就是该元素的值。
否则，依次进行以下操作：

从序列中选择两个相邻元素 elem1 和 elem2。
计算 binary_op(elem1, elem2)，并将序列中的这两个元素替换成计算结果。
重复以上两步，直到组里只剩一个元素。

给定 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) 的值类型不可移动构造 (MoveConstructible) 。
对于重载 (5,6)，T 不可移动构造 (MoveConstructible) 。
binary_op 会修改 [first, last) 的元素。
binary_op 会使 [first, last] 中的迭代器或子范围失效。

参数

first, last	-	要求和的元素范围
d_first	-	目标范围的起始，可以等于 first
policy	-	所用的执行策略。细节见执行策略。
init	-	初始值
op	-	将应用到输入迭代器的解引用结果、其他 op 的结果和 init（如果有提供）的二元函数对象 (FunctionObject) 。
类型要求
- `InputIt` 必须满足老式输入迭代器 (LegacyInputIterator) 。
- `OutputIt` 必须满足老式输出迭代器 (LegacyOutputIterator) 。
- `ForwardIt1, ForwardIt2` 必须满足老式向前迭代器 (LegacyForwardIterator) 。

返回值

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

复杂度

给定 $\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 个和中排除第 i 个输入 (函数模板)

编译器支持
自立实现与有宿主实现
语言
标准库
标准库标头
具名要求
功能特性测试宏 (C++20)
语言支持库
概念库 (C++20)
元编程库 (C++11)
诊断库
通用工具库
字符串库
容器库
迭代器库
范围库 (C++20)
算法库
数值库
本地化库
输入/输出库
文件系统库 (C++17)
正则表达式库 (C++11)
并发支持库 (C++11)
技术规范
符号索引
外部库

std::inclusive_scan

参数

返回值

复杂度

异常

示例

参阅

导航