std::inner_product

 

C++

Language

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

 

Algorithm library

Functions
Non-modifying sequence operations
all_of any_of none_of (C++11) (C++11) (C++11) for_each count count_if mismatch equal	find find_if find_if_not (C++11) find_end find_first_of adjacent_find search search_n
Modifying sequence operations
copy copy_if (C++11) copy_n (C++11) copy_backward move (C++11) move_backward (C++11) fill fill_n transform generate generate_n remove remove_if remove_copy remove_copy_if	replace replace_if replace_copy replace_copy_if swap swap_ranges iter_swap reverse reverse_copy rotate rotate_copy random_shuffle shuffle   (C++11) unique unique_copy
Partitioning operations
is_partitioned (C++11) partition partition_copy (C++11)	stable_partition partition_point (C++11)
Sorting operations (on sorted ranges)
is_sorted (C++11) is_sorted_until (C++11) sort	partial_sort partial_sort_copy stable_sort nth_element
Binary search operations (on sorted ranges)
lower_bound upper_bound	binary_search equal_range
Set operations (on sorted ranges)
merge inplace_merge includes	set_difference set_intersection set_symmetric_difference set_union
Heap operations
is_heap is_heap_until (C++11) make_heap	push_heap pop_heap sort_heap
Minimum/maximum operations
max max_element min min_element minmax (C++11) minmax_element (C++11)	lexicographical_compare is_permutation (C++11) next_permutation prev_permutation
Numeric operations
iota (C++11) accumulate inner_product	adjacent_difference partial_sum
C library
qsort	bsearch

 

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.

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. ​

Return value

The inner product of two ranges.

Possible implementation

First version
template<class InputIterator1, class InputIterator2, class T> T inner_product(InputIterator1 first1, InputIterator1 last1, InputIterator2 first2, T value) { while (first1 != last1) { value = value + *first1 * *first2; ++first1; ++first2; } return value; }
Second version
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) { while (first1 != last1) { value = op1(value, op2(*first1, *first2)); ++first1; ++first2; } return value; }

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

See also

accumulate	sums up a range of elements (function template)
partial_sum	computes the partial sum of a range of elements (function template)