std::inclusive_scan

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

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

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

技术规范

符号索引

外部库

 

算法库

受约束算法及范围上的算法 (C++20)
受约束算法： std::ranges::copy, std::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)
不修改序列的操作
all_ofany_ofnone_of (C++11)(C++11)(C++11) for_each for_each_n (C++17)	countcount_if mismatch equal adjacent_find	search search_n lexicographical_compare lexicographical_compare_three_way (C++20)	findfind_iffind_if_not (C++11) find_end find_first_of
修改序列的操作
copycopy_if (C++11) copy_n (C++11) copy_backward move (C++11) move_backward (C++11) shift_leftshift_right (C++20)(C++20) transform	fill fill_n generate generate_n swap iter_swap swap_ranges sample (C++17)	removeremove_if replacereplace_if reverse rotate unique random_shuffle (C++17 前)	remove_copyremove_copy_if replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy shuffle (C++11)
Partitioning operations
is_partitioned (C++11) partition_point (C++11)	partition partition_copy (C++11)	stable_partition
划分操作
is_partitioned (C++11) partition_point (C++11)	partition partition_copy (C++11)	stable_partition
排序操作
is_sorted (C++11) is_sorted_until (C++11)	sort stable_sort	partial_sort partial_sort_copy	nth_element
二分搜索操作
lower_bound	upper_bound	binary_search	equal_range
集合操作（在已排序范围上）
merge inplace_merge	set_difference set_intersection	set_symmetric_difference set_union	includes
堆操作
is_heap (C++11) is_heap_until (C++11)	make_heap sort_heap	push_heap pop_heap
最小/最大操作
max max_element	min min_element	minmax (C++11) minmax_element (C++11)	clamp (C++17)
排列
is_permutation (C++11)	next_permutation	prev_permutation
数值运算
iota (C++11) inner_product adjacent_difference	accumulate reduce (C++17) transform_reduce (C++17)	transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)	partial_sum inclusive_scan (C++17) 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	uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17)	destroy (C++17) destroy_n (C++17) destroy_at (C++17) construct_at (C++20)
C 库
qsort	bsearch

 

在标头 <numeric> 定义
	(1)
template< class InputIt, class OutputIt > OutputIt inclusive_scan( InputIt first,                          InputIt last, OutputIt d_first );			(C++17 起) (C++20 前)
template< class InputIt, class OutputIt > constexpr OutputIt inclusive_scan( InputIt first,                                    InputIt last, OutputIt d_first );			(C++20 起)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2 > ForwardtIt2 inclusive_scan( ExecutionPolicy&& policy, ForwardIt1 first,                             ForwardIt1 last, ForwardIt2 d_first );		(2)	(C++17 起)
		(3)
template< class InputIt, class OutputIt, class BinaryOperation > OutputIt inclusive_scan( InputIt first, InputIt last,                          OutputIt d_first, BinaryOperation binary_op );				(C++17 起) (C++20 前)
template< class InputIt, class OutputIt, class BinaryOperation > constexpr OutputIt inclusive_scan( InputIt first, InputIt last,                                    OutputIt d_first, BinaryOperation binary_op );				(C++20 起)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2,           class BinaryOperation > ForwardIt2 inclusive_scan( ExecutionPolicy&& policy,                            ForwardIt1 first, ForwardIt1 last,                            ForwardIt2 d_first, BinaryOperation binary_op );			(4)	(C++17 起)
			(5)
template< class InputIt, class OutputIt, class BinaryOperation, class T > OutputIt inclusive_scan( InputIt first, InputIt last, OutputIt d_first,                          BinaryOperation binary_op, T init );					(C++17 起) (C++20 前)
template< class InputIt, class OutputIt, class BinaryOperation, class T > constexpr OutputIt inclusive_scan( InputIt first, InputIt last, OutputIt d_first,                                    BinaryOperation binary_op, T init );					(C++20 起)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2,           class BinaryOperation, class T > ForwardIt2 inclusive_scan( ExecutionPolicy&& policy,                            ForwardIt1 first, ForwardIt1 last, ForwardIt2 d_first,                            BinaryOperation binary_op, T init );				(6)	(C++17 起)

用 binary_op （或对于重载 (1-2) 则是 std::plus<>() ）对范围 [first, last) 计算包含性前缀和运算，以 init 为初始值（若提供），并将结果写入从 d_first 开始的范围。“包含性”意味着第 i 个输入元素包含于第 i 个和。

正式而言，通过每个 [d_first, d_first + (last - first)) 中的迭代器 i ，以下列值赋值：

• 重载 (1-4) 为，对于每个区间 [first, first + (i - d_first + 1)) 中的 j ， *j... 在 binary_op 上的广义非交换和
• 重载 (5-6) 为，对于每个区间 [first, first + (i - d_first + 1)) 中的 j ， init, *j... 在 binary_op 上的广义非交换和

其中广义非交换和 GNSUM(op, a
1, ..., a
N) 定义如下：

• 若 N=1 ，则为 a
  1
• 若 N > 1 ，则为 op(GNSUM(op, a
  1, ..., a
  K), GNSUM(op, a
  M, ..., a
  N)) ，对于任何 1 < K+1 = M ≤ N 中的 K

换言之，和运算可能以任意顺序进行，而且若 binary_op 非结合，则行为是非确定的。

重载 (2,4,6) 按照 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 不应非法化范围 [first, last) 或 [d_first, d_first + (last - first)) 中的迭代器（含尾迭代器）或子范围，亦不应修改其中的元素。否则行为未定义。

参数

first, last	-	要求和的元素范围
d_first	-	目标范围的起始，可以等于 first
policy	-	所用的执行策略。细节见执行策略。
init	-	初始值（可选）
binary_op	-	将应用到解引用输入迭代器结果、其他 binary_op 结果和 init （若提供）的二元函数对象 (FunctionObject) 。
类型要求
- InputIt 必须符合老式输入迭代器 (LegacyInputIterator) 的要求。
- OutputIt 必须符合老式输出迭代器 (LegacyOutputIterator) 的要求。
- ForwardIt1 必须符合老式向前迭代器 (LegacyForwardIterator) 的要求。
- ForwardIt2 必须符合老式向前迭代器 (LegacyForwardIterator) 的要求。
- 若不提供 init ，则 decltype(first) 的值类型必须为可移动构造 (MoveConstructible) 且 binary_op(*first, *first) 必须可转换成 decltype(first) 的值类型。
- T （若提供 init ） 必须符合可移动构造 (MoveConstructible) 的要求。binary_op(init, *first) 、 binary_op(init, init) 及 binary_op(*first, *first) 都必须能转换到 T

返回值

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

复杂度

O(last - first) 次应用二元运算

异常

拥有名为 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 个输入 (函数模板)