std::transform_reduce

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

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

T transform_reduce( InputIt1 first1, InputIt1 last1,

                    InputIt2 first2, T init );
(1) (C++17 起)
(C++20 起为 constexpr)
template< class ExecutionPolicy,

          class ForwardIt1, class ForwardIt2, class T >
T transform_reduce( ExecutionPolicy&& policy,
                    ForwardIt1 first1, ForwardIt1 last1,

                    ForwardIt2 first2, T init );
(2) (C++17 起)
template< class InputIt1, class InputIt2, class T,

          class BinaryOp1, class BinaryOp2 >
T transform_reduce( InputIt1 first1, InputIt1 last1,
                    InputIt2 first2, T init,

                    BinaryOp1 reduce, BinaryOp2 transform );
(3) (C++17 起)
(C++20 起为 constexpr)
template< class ExecutionPolicy,

          class ForwardIt1, class ForwardIt2, class T,
          class BinaryOp1, class BinaryOp2 >
T transform_reduce( ExecutionPolicy&& policy,
                    ForwardIt1 first1, ForwardIt1 last1,
                    ForwardIt2 first2, T init,

                    BinaryOp1 reduce, BinaryOp2 transform );
(4) (C++17 起)
template< class InputIt, class T,

          class BinaryOp, class UnaryOp >
T transform_reduce( InputIt first, InputIt last, T init,

                    BinaryOp reduce, UnaryOp transform );
(5) (C++17 起)
(C++20 起为 constexpr)
template< class ExecutionPolicy,

          class ForwardIt, class T,
          class BinaryOp, class UnaryOp >
T transform_reduce( ExecutionPolicy&& policy,
                    ForwardIt first, ForwardIt last, T init,

                    BinaryOp reduce, UnaryOp transform );
(6) (C++17 起)
1) 等价于 transform_reduce(first1, last1, first2, init,
                 std::plus<>(), std::multiplies<>())
,实际上是默认的 std::inner_product 的等效并行版本。
3) 应用 transform 到来自范围 [first1last1) 和从 first2 开始的包含 std::distance(first1, last1) 个元素的范围的每对元素,并在 reduce 上与初始值 init 一同规约各结果(可以以未指定行为重排聚合)。
如果 reduce 不可结合或不可交换(例如浮点加法),那么结果不确定。
如果以下任何值不可转换到 T,那么程序非良构:
  • reduce(init, init)
  • reduce(init, transform(*first1, *first2))
  • reduce(transform(*first1, *first2), init)
  • reduce(transform(*first1, *first2), transform(*first1, *first2))
给定 last2first2 的下 std::distance(first1, last1) 个迭代器,如果满足以下任意条件,那么行为未定义:
  • T可移动构造 (MoveConstructible) .
  • transformreduce 会修改 [first1last1)[first2last2) 的元素。
  • transformreduce 会使 [first1last1][first2last2] 中的迭代器或子范围失效。
5) 应用 transform 到范围 [firstlast) 中的每个元素,并在 reduce 上与初始值 init 一同规约各结果(可以以未指定行为重排聚合)。
如果 reduce 不可结合或不可交换(例如浮点加法),那么结果不确定。
如果以下任何值不可转换到 T,那么程序非良构:
  • reduce(init, init)
  • reduce(init, transform(*first))
  • reduce(transform(*first), init)
  • reduce(transform(*first), transform(*first))
如果满足以下任意条件,那么行为未定义:
  • T可移动构造 (MoveConstructible)
  • transformreduce 会修改 [firstlast) 的元素。
  • transformreduce 会使 [firstlast] 中的迭代器或子范围失效。
2,4,6)(1,3,5),但按照 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 时时才会参与重载决议。

参数

first1, last1 - 包含要作为 transform 的左操作数的元素的范围
first2 - 包含要作为 transform 的右操作数的元素的范围开头
first, last - 包含要作为 transform 的单一操作数的元素的范围
init - 广义和的初始值
policy - 所用的执行策略。细节见执行策略
reduce - 二元函数对象 (FunctionObject) ,将以未指定顺序应用于 transform 的结果,其他 reduce 的结果和 init 之上。
transform - 一元或二元函数对象 (FunctionObject) ,将应用于输入范围的每个元素。其返回类型必须可由 reduce 接受为其输入。
类型要求
-
InputIt1, InputIt2, InputIt 必须满足老式输入迭代器 (LegacyInputIterator)
-
ForwardIt1, ForwardIt2, ForwardIt 必须满足老式向前迭代器 (LegacyForwardIterator)

返回值

1,2) initvaluesstd::plus<>() 上的广义和,其中 values 是通过 std::multiplies<>() 变换得到的一组值,每个值从两个输入范围中的一对元素变换而来。
3,4) initvaluesreduce 上的广义和,其中 values 是通过 transform 变换得到的一组值,每个值从两个输入范围中的一对元素变换而来。
5,6) initvaluesreduce 上的广义和,其中 values 是通过 transform 变换得到的一组值,每个值从输入范围中的一个元素变换而来。

一组元素在二元运算 binary_op 上的广义和 定义如下:

  • 如果元素组只有一个元素,那么和就是该元素的值。
  • 否则,依次进行以下操作:
  1. 从元素组中取走两个元素 elem1elem2
  2. 计算 binary_op(elem1, elem2),并将结果放回元素组。
  3. 重复以上两步,直到组里只剩一个元素。

复杂度

给定 Nstd::distance(first1, last1)(对于重载 (5,6)std::distance(first, last)):

1,2) 分别应用 O(N)std::plus<>()std::multiplies<>()
3-6) 分别应用 O(N)reducetransform

异常

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

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

注解

不会对 init 应用 transform

如果 first == lastfirst1 == last1,那么返回未经修改的 init

示例

transform_reduce 能用于并行化 std::inner_product。某些系统可能需要额外的支持以获得并行执行的优势。例如在 GNU/Linux 上 安装 Intel TBB 并对 gcc/clang 编译器提供 -ltbb 选项。

#if PARALLEL
#include <execution>
#define PAR std::execution::par,
#else
#define PAR
#endif
 
#include <algorithm>
#include <functional>
#include <iostream>
#include <iterator>
#include <locale>
#include <numeric>
#include <vector>
 
// 为使不可接合的累加运算并行化,应当选择
// transform_reduce 而非 reduce;例如,a + b * b != b + a * a
void print_sum_squared(long const num)
{
    std::cout.imbue(std::locale{"en_US.UTF8"});
    std::cout << "num = " << num << '\n';
 
    // 创建不可修改 vector 并按模式填充: 1,2,3,4, 1,2,3,4 ...
    const std::vector<long> v{[n = num * 4] {
        std::vector<long> v;
        v.reserve(n);
        std::generate_n(std::back_inserter(v), n,
            [i = 0]() mutable { return 1 + i++ % 4; });
        return v;
    }()};
 
    auto squared_sum = [](auto sum, auto val) { return sum + val * val; };
 
    auto sum1 = std::accumulate(v.cbegin(), v.cend(), 0L, squared_sum);
    std::cout << "accumulate():" << sum1 << '\n';
 
    auto sum2 = std::reduce(PAR v.cbegin(), v.cend(), 0L, squared_sum);
    std::cout << "reduce():" << sum2 << '\n';
 
    auto sum3 = std::transform_reduce(PAR v.cbegin(), v.cend(), 0L, std::plus{},
                                      [](auto val) { return val * val; });
    std::cout << "transform_reduce():" << sum3 << "\n\n";
}
 
int main()
{
    print_sum_squared(1);
    print_sum_squared(1'000);
    print_sum_squared(1'000'000);
}

可能的输出:

num = 1
accumulate():30
reduce():30
transform_reduce():30
 
num = 1,000
accumulate():30,000
reduce():-7,025,681,278,312,630,348
transform_reduce():30,000
 
num = 1,000,000
accumulate():30,000,000
reduce():-5,314,886,882,370,003,032
transform_reduce():30,000,000
 
// 并行执行于 POSIX 之上的编译器选项:
// g++ -O2 -std=c++17 -Wall -Wextra -pedantic -DPARALLEL ./example.cpp -ltbb -o tr; ./tr

参阅

对一个范围内的元素求和或折叠
(函数模板)
将一个函数应用于某一范围的各个元素,并在目标范围存储结果
(函数模板)
(C++17)
类似 std::accumulate,但不依序执行
(函数模板)