std::inclusive_scan

 

C++

言語

ヘッダ

コンセプト

言語サポートライブラリ

診断ライブラリ

ユーティリティライブラリ

文字列ライブラリ

コンテナライブラリ

アルゴリズムライブラリ

イテレータライブラリ

数値演算ライブラリ

入出力ライブラリ

ローカライゼーションライブラリ

正規表現ライブラリ(C++11)

アトミック操作ライブラリ(C++11)

スレッドサポートライブラリ(C++11)

ファイルシステムライブラリ(C++17)

技術仕様書

 

アルゴリズムライブラリ

実行ポリシー (C++17)
is_execution_policy	execution::seqexecution::parexecution::par_unseq	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policy
非変更シーケンス操作
all_ofany_ofnone_of (C++11)(C++11)(C++11) for_each for_each_n (C++17)	countcount_if mismatch equal adjacent_find	findfind_iffind_if_not (C++11) find_end find_first_of	search search_n lexicographical_compare lexicographical_compare_3way (C++20)
変更シーケンス操作
copycopy_if (C++11) copy_n (C++11) copy_backward move (C++11) move_backward (C++11) 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)
未初期化記憶域の操作
uninitialized_copy uninitialized_move (C++17)	uninitialized_copy_n (C++11) uninitialized_move_n (C++17)	uninitialized_fill	uninitialized_fill_n
分割操作
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) compare_3way (C++20)
順列
is_permutation (C++11)	next_permutation	prev_permutation
数値演算
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)
C のライブラリ
qsort	bsearch

 

ヘッダ <numeric> で定義
template<class InputIt, class OutputIt > OutputIt inclusive_scan( InputIt first,                          InputIt last, OutputIt d_first );	(1)	(C++17およびそれ以降)
template<class ExecutionPolicy, class ForwardIt1, class ForwardIt2 > ForwardtIt2 inclusive_scan( ExecutionPolicy&& policy, ForwardIt1 first,                             ForwardIt1 last, ForwardIt2 d_first );	(2)	(C++17およびそれ以降)
template<class InputIt, class OutputIt, class BinaryOperation > OutputIt inclusive_scan( InputIt first, InputIt last,                          OutputIt d_first, BinaryOperation binary_op );	(3)	(C++17およびそれ以降)
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およびそれ以降)
template<class InputIt, class OutputIt, class BinaryOperation, class T > OutputIt inclusive_scan( InputIt first, InputIt last, OutputIt d_first,                          BinaryOperation binary_op, T init );	(5)	(C++17およびそれ以降)
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およびそれ以降)

init を初期値として使用し (提供されれば)、 binary_op (オーバーロード (1-2) の場合は std::plus<>()) を用いて、範囲 [first, last) に対する inclusive prefix sum を計算し、その結果を d_first から始まる範囲に書き込みます。 「inclusive」は、 i 番目の入力要素が i 番目の合計に含まれるという意味です。

形式的には、以下の値を [d_first, d_first + (last - first)) の各イテレータ i を通して代入します。

• オーバーロード (1-4) の場合、 [first, first + (i - d_first + 1)) 内のすべての j について、 binary_op を用いた一般化された可換でない合計 *j...。
• オーバーロード (5-6) の場合、 [first, first + (i - d_first + 1)) 内のすべての j について、 binary_op を用いた一般化された可換でない合計 init, *j...。

ただし、一般化された可換でない合計 GNSUM(op, a
1, ..., a
N) は、以下のように定義されます。

• N=1 であれば、 a
  1 です。
• N > 1 であれば、 1 < K+1 = M ≤ N である任意の K について op(GNSUM(op, a
  1, ..., a
  K), GNSUM(op, a
  M, ..., a
  N)) です。

別の言い方をすると、加算操作は適当な順序で行われるかもしれず、 binary_op が結合法則を満たさなければ、動作は非決定的となります。

オーバーロード (2,4,6) は policy に従って実行されます。 このオーバーロードは、std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> が 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 は InputIterator の要件を満たさなければなりません。
- OutputIt は OutputIterator の要件を満たさなければなりません。
- ForwardIt1 は ForwardIterator の要件を満たさなければなりません。 また、 init が提供されない場合、 ForwardIt1 の値型は MoveConstructible でなければならず、 binary_op(*first, *first) は ForwardIt1 の値型に変換可能でなければなりません。
- ForwardIt2 は ForwardIterator の要件を満たさなければなりません。
- T (init が提供される場合) は MoveConstructible の要件を満たさなければなりません。 binary_op(init, *first)、 binary_op(init, init) および binary_op(*first, *first) はすべて T に変換可能でなければなりません。

戻り値

最後に書き込まれた要素の次の要素を指すイテレータ。

計算量

O(last - first) 回の二項演算の適用。

例外

テンプレート引数 ExecutionPolicy を持つオーバーロードは以下のようにエラーを報告します。

• アルゴリズムの一部として呼び出された関数の実行が例外を投げ、 ExecutionPolicy が3つの標準のポリシーのいずれかの場合は、 std::terminate が呼ばれます。 それ以外のあらゆる ExecutionPolicy については、動作は処理系定義です。
• アルゴリズムがメモリの確保に失敗した場合は、 std::bad_alloc が投げられます。

関連項目

adjacent_difference	指定範囲の隣接する要素間の差を計算します (関数テンプレート)
accumulate	指定範囲の要素を合計します (関数テンプレート)
partial_sum	指定範囲の要素の部分和を計算します (関数テンプレート)
transform_inclusive_scan (C++17)	関数オブジェクトを適用した結果に対して inclusive scan を計算します (関数テンプレート)
exclusive_scan (C++17)	std::inclusive_scan と同様ですが、 i 番目の合計に i 番目の要素が含まれません (関数テンプレート)