| 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 InputIt1,class InputIt2,class T> T inner_product( InputIt1 first1, InputIt1 last1, | (1) | (constexpr since C++20) |
template<class InputIt1,class InputIt2,class T, class BinaryOp1,class BinaryOp2> | (2) | (constexpr since C++20) |
Computes inner product (i.e. sum of products) or performs ordered map/reduce operation on the range[first1, last1) and the range ofstd::distance(first1, last1) elements beginning atfirst2.
T) with the initial valueinit and then modifies it with the expressionacc= acc+(*i1)*(*i2)(until C++20)acc= std::move(acc)+(*i1)*(*i2)(since C++20) for every iteratori1 in the range[first1, last1) in order and its corresponding iteratori2 in the range beginning atfirst2. For built-in meaning of + and *, this computes inner product of the two ranges.T) with the initial valueinit and then modifies it with the expressionacc= op1(acc, op2(*i1,*i2))(until C++20)acc= op1(std::move(acc), op2(*i1,*i2))(since C++20) for every iteratori1 in the range[first1, last1) in order and its corresponding iteratori2 in the range beginning atfirst2.Givenlast2 as thestd::distance(first1, last1)th next iterator offirst2, if any of the following conditions is satisfied, the behavior is undefined:
T is notCopyConstructible.T is notCopyAssignable.[first1, last1) or[first2, last2).[first1, last1] or[first2, last2].Contents |
| first1, last1 | - | the pair of iterators defining therange of elements to |
| first2 | - | the beginning of the second range of elements |
| init | - | initial value of the sum of the products |
| op1 | - | binary operation function object that will be applied. This "sum" function takes a value returned byop2 and the current value of the accumulator and produces a new value to be stored in the accumulator. 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&. |
| op2 | - | binary operation function object that will be applied. This "product" function takes one value from each range and produces a new value. 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 | ||
-InputIt1, InputIt2 must meet the requirements ofLegacyInputIterator. | ||
acc after all modifications.
| inner_product (1) |
|---|
template<class InputIt1,class InputIt2,class T>constexpr// since C++20T inner_product(InputIt1 first1, InputIt1 last1, InputIt2 first2, T init){while(first1!= last1){ init= std::move(init)+(*first1)*(*first2);// std::move since C++20++first1;++first2;} return init;} |
| inner_product (2) |
template<class InputIt1,class InputIt2,class T,class BinaryOp1,class BinaryOp2>constexpr// since C++20T inner_product(InputIt1 first1, InputIt1 last1, InputIt2 first2, T init, BinaryOp1 op1, BinaryOp2 op2){while(first1!= last1){ init= op1(std::move(init), op2(*first1,*first2));// std::move since C++20++first1;++first2;} return init;} |
The parallelizable version of this algorithm,std::transform_reduce, requiresop1 andop2 to be commutative and associative, butstd::inner_product makes no such requirement, and always performs the operations in the order given.
#include <functional>#include <iostream>#include <numeric>#include <vector> int main(){std::vector<int> a{0,1,2,3,4};std::vector<int> b{5,4,2,3,1}; int r1= std::inner_product(a.begin(), a.end(), b.begin(),0);std::cout<<"Inner product of a and b: "<< r1<<'\n'; int r2= std::inner_product(a.begin(), a.end(), b.begin(),0,std::plus<>(),std::equal_to<>());std::cout<<"Number of pairwise matches between a and b: "<< r2<<'\n';}
Output:
Inner product of a and b: 21Number of pairwise matches between a and b: 2
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 | op1 andop2 could not have side effects | they cannot modify the ranges involved |
(C++17) | applies an invocable, then reduces out of order (function template)[edit] |
| sums up or folds a range of elements (function template)[edit] | |
| computes the partial sum of a range of elements (function template)[edit] |