std::reduce

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

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

typename std::iterator_traits<InputIt>::value_type

    reduce( InputIt first, InputIt last );
(C++17 起)
(C++20 前)
template< class InputIt >

constexpr typename std::iterator_traits<InputIt>::value_type

    reduce( InputIt first, InputIt last );
(C++20 起)
template< class ExecutionPolicy, class ForwardIt >

typename std::iterator_traits<ForwardIt>::value_type
    reduce( ExecutionPolicy&& policy,

            ForwardIt first, ForwardIt last );
(2) (C++17 起)
(3)
template< class InputIt, class T >
T reduce( InputIt first, InputIt last, T init );
(C++17 起)
(C++20 前)
template< class InputIt, class T >
constexpr T reduce( InputIt first, InputIt last, T init );
(C++20 起)
template< class ExecutionPolicy, class ForwardIt, class T >

T reduce( ExecutionPolicy&& policy,

          ForwardIt first, ForwardIt last, T init );
(4) (C++17 起)
(5)
template< class InputIt, class T, class BinaryOp >
T reduce( InputIt first, InputIt last, T init, BinaryOp binary_op );
(C++17 起)
(C++20 前)
template< class InputIt, class T, class BinaryOp >
constexpr T reduce( InputIt first, InputIt last, T init, BinaryOp binary_op );
(C++20 起)
template< class ExecutionPolicy, class ForwardIt, class T, class BinaryOp >

T reduce( ExecutionPolicy&& policy,

          ForwardIt first, ForwardIt last, T init, BinaryOp binary_op );
(6) (C++17 起)
1)reduce(first, last, typename std::iterator_traits<InputIt>::value_type{})
3)reduce(first, last, init, std::plus<>())
5)binary_op 上以初值 init 对范围 [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 时时才会参与重载决议。

binary_op 不可结合或不可交换,则行为非确定。

binary_op 修改 [firstlast) 中任何元素或使范围中的任何迭代器(含尾迭代器)失效,则行为未定义。

目录

[编辑] 参数

first, last - 要应用算法的元素范围
init - 广义和的初值
policy - 所用的执行策略。细节见执行策略
binary_op - 将以未指定顺序应用于输入迭代器的解引用结果、其他 binary_op 的结果及 init 上的二元函数对象 (FunctionObject)
类型要求
-
InputIt 必须满足老式输入迭代器 (LegacyInputIterator)
-
ForwardIt 必须满足老式向前迭代器 (LegacyForwardIterator)
-
T 必须满足可移动构造 (MoveConstructible) 。而且 binary_op(init, *first)binary_op(*first, init)binary_op(init, init)binary_op(*first, *first) 必须可转换到 T

[编辑] 返回值

init*first*(first+1)、…… *(last-1)binary_op 上的广义和,

其中广义和 GSUM(op, a
1
, ..., a
N
)
定义如下:

  • N = 1,则为 a
    1
  • N > 1,则为 op(GSUM(op, b
    1
    , ..., b
    K
    ), GSUM(op, b
    M
    , ..., b
    N
    ))
    ,其中
  • b
    1
    , ..., b
    N
    可以是 a1, ..., aN 的任何排列,且
  • 1 < K + 1 = M ≤ N

换言之,reduce 表现类似 std::accumulate,但范围中的元素可能以任意顺序分组并重排。

[编辑] 复杂度

O(last - first) 次应用 binary_op

[编辑] 异常

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

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

[编辑] 注解

若范围为空,则返回不修改的 init

[编辑] 示例

std::reducestd::accumulate 间并行的比较:

#if PARALLEL
#include <execution>
#define SEQ std::execution::seq,
#define PAR std::execution::par,
#else
#define SEQ
#define PAR
#endif
 
#include <chrono>
#include <iomanip>
#include <iostream>
#include <numeric>
#include <utility>
#include <vector>
 
int main()
{
    std::cout.imbue(std::locale("en_US.UTF-8"));
    std::cout << std::fixed << std::setprecision(1);
    auto eval = [](auto fun)
    {
        const auto t1 = std::chrono::high_resolution_clock::now();
        const auto [name, result] = fun();
        const auto t2 = std::chrono::high_resolution_clock::now();
        const std::chrono::duration<double, std::milli> ms = t2 - t1;
        std::cout << std::setw(28) << std::left << name << "sum: "
                  << result << "\t time: " << ms.count() << " ms\n";
    };
    {
        const std::vector<double> v(100'000'007, 0.1);
 
        eval([&v]{ return std::pair{"std::accumulate (double)",
            std::accumulate(v.cbegin(), v.cend(), 0.0)}; } );
        eval([&v]{ return std::pair{"std::reduce (seq, double)",
            std::reduce(SEQ v.cbegin(), v.cend())}; } );
        eval([&v]{ return std::pair{"std::reduce (par, double)",
            std::reduce(PAR v.cbegin(), v.cend())}; } );
    }
    {
        const std::vector<long> v(100'000'007, 1);
 
        eval([&v]{ return std::pair{"std::accumulate (long)",
            std::accumulate(v.cbegin(), v.cend(), 0l)}; } );
        eval([&v]{ return std::pair{"std::reduce (seq, long)",
            std::reduce(SEQ v.cbegin(), v.cend())}; } );
        eval([&v]{ return std::pair{"std::reduce (par, long)",
            std::reduce(PAR v.cbegin(), v.cend())}; } );
    }
}

可能的输出:

// POSIX: g++ -std=c++23 ./example.cpp -ltbb -O3; ./a.out
std::accumulate (double)    sum: 10,000,000.7    time: 356.9 ms
std::reduce (seq, double)   sum: 10,000,000.7    time: 140.1 ms
std::reduce (par, double)   sum: 10,000,000.7    time: 140.1 ms
std::accumulate (long)      sum: 100,000,007     time: 46.0 ms
std::reduce (seq, long)     sum: 100,000,007     time: 67.3 ms
std::reduce (par, long)     sum: 100,000,007     time: 63.3 ms
 
// POSIX: g++ -std=c++23 ./example.cpp -ltbb -O3 -DPARALLEL; ./a.out
std::accumulate (double)    sum: 10,000,000.7    time: 353.4 ms
std::reduce (seq, double)   sum: 10,000,000.7    time: 140.7 ms
std::reduce (par, double)   sum: 10,000,000.7    time: 24.7 ms
std::accumulate (long)      sum: 100,000,007     time: 42.4 ms
std::reduce (seq, long)     sum: 100,000,007     time: 52.0 ms
std::reduce (par, long)     sum: 100,000,007     time: 23.1 ms

[编辑] 参阅

对一个范围内的元素求和或折叠
(函数模板) [编辑]
将一个函数应用于某一范围的各个元素,并在目标范围存储结果
(函数模板) [编辑]
应用一个可调用物,然后以乱序规约
(函数模板) [编辑]
左折叠范围内的元素
(niebloid) [编辑]