std::exclusive_scan
ヘッダ <numeric> で定義 | ||
template<class InputIt, class OutputIt, class T > OutputIt exclusive_scan( InputIt first, InputIt last, | (1) | (C++17およびそれ以降) |
template<class ExecutionPolicy, class ForwardIt1, class ForwardIt2, class T > ForwardIt2 exclusive_scan( ExecutionPolicy&& policy, ForwardIt1 first, ForwardIt1 last, | (2) | (C++17およびそれ以降) |
template<class InputIt, class OutputIt, class T, class BinaryOperation > | (3) | (C++17およびそれ以降) |
template<class ExecutionPolicy, class ForwardIt1, class ForwardIt2, class T, class BinaryOperation > | (4) | (C++17およびそれ以降) |
init を初期値として使用し、 binary_op (オーバーロード (1-2) の場合は std::plus<>()) を用いて、範囲 [first, last) に対する exclusive prefix sum を計算し、その結果を d_first から始まる範囲に書き込みます。 「exclusive」は、 i 番目の入力要素が i 番目の合計に含まれないという意味です。
形式的には、 [first, first + (i - d_first)) 内のすべての j について、 init, *j... の binary_op による一般化された可換でない合計の値を、 [d_first, d_first + (last - first)) 内の各イテレータ i を通して代入します。
ただし、一般化された可換でない合計 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) は このオーバーロードは、 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, ForwardIt2 は ForwardIterator の要件を満たさなければなりません。 | ||
-T は 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 が投げられます。
[編集]例
| This section is incomplete Reason: no example |
[編集]関連項目
| 指定範囲の隣接する要素間の差を計算します (関数テンプレート) | |
| 指定範囲の要素を合計します (関数テンプレート) | |
| 指定範囲の要素の部分和を計算します (関数テンプレート) | |
(C++17) | 関数オブジェクトを適用した結果に対して exclusive scan を計算します (関数テンプレート) |
(C++17) | std::partial_sum と同様ですが、計算順序は不定です (関数テンプレート) |
