Namespaces
Variants
Views
Actions

std::inner_product

From cppreference.com
 
 
 
Defined in header <numeric>
template< class InputIterator1, class InputIterator2, class T >

T inner_product( InputIterator1 first1, InputIterator1 last1,

                 InputIterator2 first2, T value );
(1)
template<

    class InputIterator1,
    class InputIterator2,
    class T,
    class BinaryOperation1,
    class BinaryOperation2
> T inner_product( InputIterator1 first1, InputIterator1 last1,
                   InputIterator2 first2, T value,
                   BinaryOperation1 op1,

                   BinaryOperation2 op2 );
(2)

Computes inner product (i.e. sum of products) of the range [first1, last1) and another range beginning at first2. The first version uses operator* to compute product of the element pairs and operator+ to sum up the products, the second version uses op2 and op1 for these tasks respectively.

Contents

[edit] Parameters

first1, last1 - the first range of elements
first2 - the beginning of the second range of elements
value - initial value of the sum of the products
op1 - binary operation function object that will be applied. This function takes a value returned by op2 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 have const &.
The types  Type1 and  Type2 must be such that objects of types T and Type3 can be implicitly converted to  Type1 and  Type2 respectively. The type  Ret must be such that an object of type T can be assigned a value of type  Ret. ​

op2 - binary operation function object that will be applied. This 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 have const &.
The types  Type1 and  Type2 must be such that objects of types InputIterator1 and InputIterator2 can be dereferenced and then implicitly converted to  Type1 and  Type2 respectively. The type  Ret must be such that an object of type Type3 can be assigned a value of type  Ret. ​

[edit] Return value

The inner product of two ranges.

[edit] Possible implementation

[edit] Example

#include <numeric>
#include <iostream>
#include <vector>
#include <functional>
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<int>(), std::equal_to<int>());
    std::cout << "Number of pairwise matches between a and b: " <<  r2 << '\n';
}

Output:

Inner product of a and b: 21
Number of pairwise matches between a and b: 2

[edit] See also

sums up a range of elements
(function template) [edit]
computes the partial sum of a range of elements
(function template) [edit]