std::transform_inclusive_scan

来自cppreference.com
< cpp‎ | algorithm
 
 
算法库
受约束算法及范围上的算法 (C++20)
受约束算法: std::ranges::copy, std::ranges::sort, ...
执行策略 (C++17)
不修改序列的操作
(C++11)(C++11)(C++11)
(C++17)
修改序列的操作
Partitioning operations
划分操作
排序操作
(C++11)
二分搜索操作
集合操作(在已排序范围上)
堆操作
(C++11)
最小/最大操作
(C++11)
(C++17)

排列
数值运算
transform_inclusive_scan
(C++17)

未初始化存储上的操作
(C++17)
(C++17)
(C++17)
C 库
 
在标头 <numeric> 定义
(1)
template< class InputIt, class OutputIt,

          class BinaryOperation, class UnaryOperation >
OutputIt transform_inclusive_scan( InputIt first, InputIt last, OutputIt d_first,

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

          class BinaryOperation, class UnaryOperation >
constexpr OutputIt transform_inclusive_scan( InputIt first, InputIt last,
                                             OutputIt d_first,
                                             BinaryOperation binary_op,

                                             UnaryOperation unary_op );
(C++20 起)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2,

          class BinaryOperation, class UnaryOperation >
ForwardIt2 transform_inclusive_scan( ExecutionPolicy&& policy,
                                     ForwardIt1 first, ForwardIt1 last, ForwardIt2 d_first,

                                     BinaryOperation binary_op, UnaryOperation unary_op );
(2) (C++17 起)
(3)
template< class InputIt, class OutputIt,

          class BinaryOperation, class UnaryOperation, class T >
OutputIt transform_inclusive_scan( InputIt first, InputIt last, OutputIt d_first,
                                   BinaryOperation binary_op, UnaryOperation unary_op,

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

          class BinaryOperation, class UnaryOperation, class T >
constexpr OutputIt transform_inclusive_scan( InputIt first, InputIt last,
                                             OutputIt d_first,
                                             BinaryOperation binary_op,
                                             UnaryOperation unary_op,

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

          class BinaryOperation, class UnaryOperation, class T >
ForwardIt2 transform_inclusive_scan( ExecutionPolicy&& policy,
                                     ForwardIt1 first, ForwardIt1 last, ForwardIt2 d_first,
                                     BinaryOperation binary_op, UnaryOperation unary_op,

                                     T init );
(4) (C++17 起)

unary_op 变换范围 [first, last) 中的每个元素,然后用 binary_op 在范围上计算包含前缀和,可选地以 init 为初值,并写结果到始于 d_first 的范围。“包含”表明第 i 个元素包含于第 i 个和。

形式上,通过每个 [d_first, d_first + (last - first)) 中的迭代器 i 赋以下值

  • 对于重载 (1-2) ,对于 [first, first + (i - d_first + 1)) 中每个 j ,为 unary_op(*j)...binary_op 上的的广义非交换和,
  • 对于重载 (3-4) ,对于 [first, first + (i - d_first + 1)) 中每个 j ,为 init, unary_op(*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) 按照 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 时才会参与重载决议。

unary_opbinary_op 不应非法化范围 [first, last)[d_first, d_first + (last - first)) 中的迭代器(含尾迭代器)或子范围,不修改其中的元素。否则行为未定义。

参数

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

返回值

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

复杂度

每个 binary_opunary_op 应用 O(last - first) 次。

异常

拥有名为 ExecutionPolicy 的模板形参的重载按下列方式报告错误:

  • 如果作为算法一部分调用的函数的执行抛出异常,且 ExecutionPolicy标准策略之一,那么调用 std::terminate。对于任何其他 ExecutionPolicy,行为由实现定义。
  • 如果算法无法分配内存,那么抛出 std::bad_alloc

注解

不应用 unary_opinit

不同于 std::transform_exclusive_scan ,参数 init 出现于最后,因为它对此函数是可选的。

示例

#include <functional>
#include <iostream>
#include <iterator>
#include <numeric>
#include <vector>
 
int main()
{
  auto times_10 = [](int x) { return x * 10; };
  std::vector data {3, 1, 4, 1, 5, 9, 2, 6};
 
  std::cout << "10 times exclusive sum: ";
  std::transform_exclusive_scan(data.begin(), data.end(),
				std::ostream_iterator<int>(std::cout, " "),
				0, std::plus<int>{}, times_10);
  std::cout << "\n10 times inclusive sum: ";
  std::transform_inclusive_scan(data.begin(), data.end(),
				std::ostream_iterator<int>(std::cout, " "),
				std::plus<int>{}, times_10);
}

输出:

10 times exclusive sum: 0 30 40 80 90 140 230 250 
10 times inclusive sum: 30 40 80 90 140 230 250 310

参阅

计算范围内元素的部分和
(函数模板)
将一个函数应用于某一范围的各个元素,并在目标范围存储结果
(函数模板)
类似 std::partial_sum,第 i 个和中包含第 i 个输入
(函数模板)
应用一个函数对象,然后进行排除扫描
(函数模板)