std::exclusive_scan

来自cppreference.com
< cpp‎ | algorithm
 
 
算法库
受约束算法及范围上的算法 (C++20)
Constrained algorithms, e.g. ranges::copy, ranges::sort, ...
执行策略 (C++17)
排序和相关操作
划分操作
排序操作
二分搜索操作(在已划分范围上)
集合操作(在已排序范围上)
归并操作(在已排序范围上)
堆操作
最小/最大操作
(C++11)
(C++17)
字典序比较操作
排列操作
C 库

数值运算
(C++11)                       
(C++17)  
exclusive_scan
(C++17)
在未初始化内存上的操作
 
在标头 <numeric> 定义
(1)
template< class InputIt, class OutputIt, class T >

OutputIt exclusive_scan( InputIt first, InputIt last,

                         OutputIt d_first, T init );
(C++17 起)
(C++20 前)
template< class InputIt, class OutputIt, class T >

constexpr OutputIt exclusive_scan( InputIt first, InputIt last,

                                   OutputIt d_first, T init );
(C++20 起)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2, class T >

ForwardIt2 exclusive_scan( ExecutionPolicy&& policy,
                           ForwardIt1 first, ForwardIt1 last,

                           ForwardIt2 d_first, T init );
(2) (C++17 起)
(3)
template< class InputIt, class OutputIt,

          class T, class BinaryOperation >
OutputIt exclusive_scan( InputIt first, InputIt last,
                         OutputIt d_first, T init,

                         BinaryOperation binary_op );
(C++17 起)
(C++20 前)
template< class InputIt, class OutputIt,

          class T, class BinaryOperation >
constexpr OutputIt exclusive_scan( InputIt first, InputIt last,
                                   OutputIt d_first, T init,

                                   BinaryOperation binary_op );
(C++20 起)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2,

          class T, class BinaryOperation >
ForwardIt2 exclusive_scan( ExecutionPolicy&& policy,
                           ForwardIt1 first, ForwardIt1 last,
                           ForwardIt2 d_first, T init,

                           BinaryOperation binary_op );
(4) (C++17 起)

binary_op(或对于重载 (1,2)std::plus<>())计算范围 [firstlast) 上的排除性前缀求和运算,以 init 为初始值,并写入结果到从 d_first 开始的范围。“排除性”表示第 i 个输入元素不包含于第 i 个和。

正式而言,通过 [d_firstd_first + (last - first)) 中的每个 j 进行赋值,其值为对于 [firstfirst + (i - d_first)) 中的每个迭代器 j,以 binary_op 计算 init, *j... 的广义非交换求和。

其中广义非交换和 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) 按照 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 不应使范围 [firstlast)[d_firstd_first + (last - first)) 中的迭代器(含尾迭代器)或子范围失效,亦不应修改其中的元素。否则行为未定义。

目录

[编辑] 参数

first, last - 欲求和的元素范围
d_first - 目标范围的起始;可以等于 first
policy - 所用的执行策略。细节见执行策略
init - 初始值
binary_op - 二元函数对象 (FunctionObject) ,将应用到各输入迭代器的解引用结果、其他 binary_op 的结果和 init 之上。
类型要求
-
InputIt 必须满足老式输入迭代器 (LegacyInputIterator)
-
OutputIt 必须满足老式输出迭代器 (LegacyOutputIterator)
-
ForwardIt1, ForwardIt2 必须满足老式向前迭代器 (LegacyForwardIterator)
-
T 必须满足可移动构造 (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

[编辑] 参阅

计算范围内各相邻元素之间的差
(函数模板) [编辑]
对一个范围内的元素求和或折叠
(函数模板) [编辑]
计算范围内元素的部分和
(函数模板) [编辑]
应用一个可调用物,然后进行排除扫描
(函数模板) [编辑]
类似 std::partial_sum,第 i 个和中包含第 i 个输入
(函数模板) [编辑]