Constrained algorithms and algorithms on ranges(C++20) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Constrained algorithms, e.g.ranges::copy,ranges::sort, ... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Execution policies(C++17) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Numeric operations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Operations on uninitialized memory | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Common mathematical functions | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Mathematical special functions(C++17) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Mathematical constants(C++20) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Basic linear algebra algorithms(C++26) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Data-parallel types (SIMD)(C++26) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Floating-point environment(C++11) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Complex numbers | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Numeric array (valarray ) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Pseudo-random number generation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bit manipulation(C++20) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Saturation arithmetic(C++26) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Factor operations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Interpolations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Generic numeric operations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
C-style checked integer arithmetic | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Defined in header <numeric> | ||
template<class InputIt,class T> T accumulate( InputIt first, InputIt last, T init); | (1) | (constexpr since C++20) |
template<class InputIt,class T,class BinaryOp> T accumulate( InputIt first, InputIt last, T init, BinaryOp op); | (2) | (constexpr since C++20) |
Computes the sum of the given valueinit and the elements in the range[
first,
last)
.
T
) with the initial valueinit and then modifies it withacc= acc+*i(until C++20)acc= std::move(acc)+*i(since C++20) for every iteratori in the range[
first,
last)
in order.T
) with the initial valueinit and then modifies it withacc= op(acc,*i)(until C++20)acc= op(std::move(acc),*i)(since C++20) for every iteratori in the range[
first,
last)
in order.If any of the following conditions is satisfied, the behavior is undefined:
T
is notCopyConstructible.T
is notCopyAssignable.[
first,
last)
.[
first,
last]
.Contents |
first, last | - | the pair of iterators defining therange of elements to accumulate |
init | - | initial value of the accumulate |
op | - | binary operation function object that will be applied. The signature of the function should be equivalent to the following: Ret fun(const Type1&a,const Type2&b); The signature does not need to haveconst&. |
Type requirements | ||
-InputIt must meet the requirements ofLegacyInputIterator. |
acc after all modifications.
accumulate (1) |
---|
template<class InputIt,class T>constexpr// since C++20T accumulate(InputIt first, InputIt last, T init){for(; first!= last;++first) init= std::move(init)+*first;// std::move since C++20 return init;} |
accumulate (2) |
template<class InputIt,class T,class BinaryOperation>constexpr// since C++20T accumulate(InputIt first, InputIt last, T init, BinaryOperation op){for(; first!= last;++first) init= op(std::move(init),*first);// std::move since C++20 return init;} |
std::accumulate
performs a leftfold. In order to perform a right fold, one must reverse the order of the arguments to the binary operator, and use reverse iterators.
If left to type inference,op operates on values of the same type asinit which can result in unwanted casting of the iterator elements. For example,std::accumulate(v.begin(), v.end(),0) likely does not give the result one wishes for whenv is of typestd::vector<double>.
#include <functional>#include <iostream>#include <numeric>#include <string>#include <vector> int main(){std::vector<int> v{1,2,3,4,5,6,7,8,9,10}; int sum= std::accumulate(v.begin(), v.end(),0);int product= std::accumulate(v.begin(), v.end(),1,std::multiplies<int>()); auto dash_fold=[](std::string a,int b){return std::move(a)+'-'+std::to_string(b);}; std::string s= std::accumulate(std::next(v.begin()), v.end(),std::to_string(v[0]),// start with first element dash_fold); // Right fold using reverse iteratorsstd::string rs= std::accumulate(std::next(v.rbegin()), v.rend(),std::to_string(v.back()),// start with last element dash_fold); std::cout<<"sum: "<< sum<<'\n'<<"product: "<< product<<'\n'<<"dash-separated string: "<< s<<'\n'<<"dash-separated string (right-folded): "<< rs<<'\n';}
Output:
sum: 55product: 3628800dash-separated string: 1-2-3-4-5-6-7-8-9-10dash-separated string (right-folded): 10-9-8-7-6-5-4-3-2-1
The following behavior-changing defect reports were applied retroactively to previously published C++ standards.
DR | Applied to | Behavior as published | Correct behavior |
---|---|---|---|
LWG 242 | C++98 | op could not have side effects | it cannot modify the ranges involved |
computes the differences between adjacent elements in a range (function template)[edit] | |
computes the inner product of two ranges of elements (function template)[edit] | |
computes the partial sum of a range of elements (function template)[edit] | |
(C++17) | similar tostd::accumulate, except out of order (function template)[edit] |
(C++23) | left-folds a range of elements (algorithm function object)[edit] |