Difference between revisions of "cpp/algorithm/reduce"
(+) |
(mention the overload set constraint) |
||
Line 37: | Line 37: | ||
@3@ same as {{c|reduce(first, last, init, std::plus<>())}} | @3@ same as {{c|reduce(first, last, init, std::plus<>())}} | ||
@5@ Reduces the range {{math|[first; last)}}, possibly permuted and aggregated in unspecified manner, along with the initial value {{tt|init}} over {{tt|binary_op}}. | @5@ Reduces the range {{math|[first; last)}}, possibly permuted and aggregated in unspecified manner, along with the initial value {{tt|init}} over {{tt|binary_op}}. | ||
− | @2,4,6@ Same as {{v|1,3,5}}, but executed according to {{tt|exec}} | + | @2,4,6@ Same as {{v|1,3,5}}, but executed according to {{tt|exec}}. These overloads do not participate in overload resolution unless {{c|std::is_execution_policy_v<std::decay_t<ExecutionPolicy>>}} is true |
The behavior is non-deterministic if {{tt|binary_op}} is not associative or not commutative. | The behavior is non-deterministic if {{tt|binary_op}} is not associative or not commutative. |
Revision as of 12:00, 18 March 2016
Defined in header <numeric>
|
||
template<class InputIt> typename std::iterator_traits<InputIt>::value_type reduce( |
(1) | (since C++17) |
template<class ExecutionPolicy, class InputIterator> typename std::iterator_traits<InputIt>::value_type reduce( |
(2) | (since C++17) |
template<class InputIt, class T> T reduce(InputIt first, InputIt last, T init); |
(3) | (since C++17) |
template<class ExecutionPolicy, class InputIt, class T> T reduce(ExecutionPolicy&& exec, |
(4) | (since C++17) |
template<class InputIt, class T, class BinaryOp> T reduce(InputIt first, InputIt last, T init, BinaryOp binary_op); |
(5) | (since C++17) |
template<class ExecutionPolicy, class InputIt, class T, class BinaryOp> T reduce(ExecutionPolicy&& exec, |
(6) | (since C++17) |
init
over binary_op
. exec
. These overloads do not participate in overload resolution unless std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> is trueThe behavior is non-deterministic if binary_op
is not associative or not commutative.
The behavior is undefined if binary_op
modifies any element or invalidates any iterator in [first; last).
Contents |
Parameters
first, last | - | the range of elements to apply the algorithm to |
init | - | the initial value of the generalized sum |
policy | - | the execution policy to use. See execution policy for details. |
binary_op | - | binary Template:concept that will be applied in unspecified order to the result of dereferencing the input iterators, the results of other binary_op and init .
|
Type requirements |
Return value
Generalized sum of init
and *first
, *(first+1)
, ... *(last-1)
over binary_op
,
where generalized sum GSUM(op, a1, ..., aN) is defined as follows:
- if N=1, a1
- if N > 1, op(GSUM(op, b1, ..., bK), GSUM(op, bM, ..., bN)) where
- b1, ..., bN may be any permutation of a1, ..., aN and
- 1 < K+1 = M ≤ N
in other words, the elements of the range may be grouped and rearranged in arbitrary order
Complexity
O(last - first) applications of binary_op
.
Exceptions
The overloads with a template parameter named ExecutionPolicy
report errors as follows:
- If execution of a function invoked as part of the algorithm throws an exception and
ExecutionPolicy
is one of the standard policies, std::terminate is called. For any otherExecutionPolicy
, the behavior is implementation-defined. - If the algorithm fails to allocate memory, std::bad_alloc is thrown.
Notes
If the range is empty, init
is returned, unmodified
Example
reduce is the out-of-order version of std::accumulate:
#include <iostream> #include <chrono> #include <vector> #include <numeric> #include <execution_policy> int main() { std::vector<double> v(10'000'007, 0.5); { auto t1 = std::chrono::high_resolution_clock::now(); double result = std::accumulate(v.begin(), v.end(), 0.0); auto t2 = std::chrono::high_resolution_clock::now(); std::chrono::duration<double, std::milli> ms = t2 - t1; std::cout << std::fixed << "std::accumulate result " << result << " took " << ms.count() << " ms\n"; } { auto t1 = std::chrono::high_resolution_clock::now(); double result = std::reduce(std::par, v.begin(), v.end()); auto t2 = std::chrono::high_resolution_clock::now(); std::chrono::duration<double, std::milli> ms = t2 - t1; std::cout << "std::reduce result " << result << " took " << ms.count() << " ms\n"; } }
Possible output:
std::accumulate result 5000003.50000 took 12.7365 ms std::reduce result 5000003.50000 took 5.06423 ms
See also
sums up or folds a range of elements (function template) | |
applies a function to a range of elements, storing results in a destination range (function template) | |
(C++17) |
applies an invocable, then reduces out of order (function template) |