std::inner_product

 

C++

Compiler support

Freestanding and hosted

Language

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Technical specifications

Symbols index

External libraries

 

Algorithm library

Constrained algorithms and algorithms on ranges (C++20)
Constrained algorithms, e.g. ranges::copy, ranges::sort, ...
Execution policies (C++17)
is_execution_policy (C++17)	execution::seqexecution::parexecution::par_unseqexecution::unseq (C++17)(C++17)(C++17)(C++20)	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policyexecution::parallel_unsequenced (C++17)(C++17)(C++17)(C++20)
Non-modifying sequence operations
all_ofany_ofnone_of (C++11)(C++11)(C++11) for_each for_each_n (C++17)	countcount_if mismatch equal adjacent_find	search search_n lexicographical_compare lexicographical_compare_three_way (C++20)	findfind_iffind_if_not (C++11) find_end find_first_of
Modifying sequence operations
copycopy_if (C++11) copy_n (C++11) copy_backward move (C++11) move_backward (C++11) shift_leftshift_right (C++20)(C++20) transform	fill fill_n generate generate_n swap iter_swap swap_ranges sample (C++17)	removeremove_if replacereplace_if reverse rotate unique random_shuffle (until C++17)	remove_copyremove_copy_if replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy shuffle (C++11)
Partitioning operations
is_partitioned (C++11) partition_point (C++11)	partition partition_copy (C++11)	stable_partition
Sorting operations
is_sorted (C++11) is_sorted_until (C++11)	sort stable_sort	partial_sort partial_sort_copy	nth_element
Binary search operations
lower_bound	upper_bound	binary_search	equal_range
Set operations (on sorted ranges)
merge inplace_merge	set_difference set_intersection	set_symmetric_difference set_union	includes
Heap operations
is_heap (C++11) is_heap_until (C++11)	make_heap sort_heap	push_heap pop_heap
Minimum/maximum operations
max max_element	min min_element	minmax (C++11) minmax_element (C++11)	clamp (C++17)
Permutations
is_permutation (C++11)	next_permutation	prev_permutation
Numeric operations
iota (C++11) inner_product adjacent_difference	accumulate reduce (C++17) transform_reduce (C++17)	transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)	partial_sum inclusive_scan (C++17) exclusive_scan (C++17)
Operations on uninitialized storage
uninitialized_copy uninitialized_move (C++17) uninitialized_fill	uninitialized_copy_n (C++11) uninitialized_move_n (C++17) uninitialized_fill_n	uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17)	destroy (C++17) destroy_n (C++17) destroy_at (C++17) construct_at (C++20)
C library
qsort	bsearch

 

Defined in header <numeric>
	(1)
template< class InputIt1, class InputIt2, class T > T inner_product( InputIt1 first1, InputIt1 last1,                  InputIt2 first2, T init );			(until C++20)
template< class InputIt1, class InputIt2, class T > constexpr T inner_product( InputIt1 first1, InputIt1 last1,                            InputIt2 first2, T init );			(since C++20)
		(2)
template< class InputIt1, class InputIt2, class T,           class BinaryOperation1, class BinaryOperation2 > T inner_product( InputIt1 first1, InputIt1 last1,                  InputIt2 first2, T init,                  BinaryOperation1 op1,                  BinaryOperation2 op2 );				(until C++20)
template< class InputIt1, class InputIt2, class T,           class BinaryOperation1, class BinaryOperation2 > constexpr T inner_product( InputIt1 first1, InputIt1 last1,                            InputIt2 first2, T init,                            BinaryOperation1 op1,                            BinaryOperation2 op2 );				(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 beginning at first2.

1) Initializes the accumulator acc with the initial value init and then

modifies it with the expression acc = acc + *first1 * *first2, then modifies again with the expression acc = acc + *(first1+1) * *(first2+1), etc	(until C++20)
modifies it with the expression acc = std::move(acc) + *first1 * *first2, then modifies again with the expression acc = std::move(acc) + *(first1+1) * *(first2+1), etc	(since C++20)

until reaching last1. For built-in meaning of + and *, this computes inner product of the two ranges.

2) Initializes the accumulator acc with the initial value init and then

modifies it with the expression acc = op1(acc, op2(*first1, *first2)), then modifies again with the expression acc = op1(acc, op2(*(first1+1), *(first2+1))), etc	(until C++20)
modifies it with the expression acc = op1(std::move(acc), op2(*first1, *first2)), then modifies again with the expression acc = op1(std::move(acc), op2(*(first1+1), *(first2+1))), etc	(since C++20)

until reaching last1.

op1 or op2 must not have side effects.	(until C++11)
op1 or op2 must not invalidate any iterators, including the end iterators, or modify any elements of the range involved.	(since C++11)

Parameters

first1, last1	-	the first range of elements
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 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 "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 have const &. The types Type1 and Type2 must be such that objects of types InputIt1 and InputIt2 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. ​
Type requirements
- InputIt1, InputIt2 must meet the requirements of LegacyInputIterator.
- ForwardIt1, ForwardIt2 must meet the requirements of LegacyForwardIterator.
- T must meet the requirements of CopyAssignable and CopyConstructible.

Return value

The final value of acc as described above.

Possible implementation

First version
template<class InputIt1, class InputIt2, class T> constexpr // since C++20 T 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; }
Second version
template<class InputIt1, class InputIt2, class T, class BinaryOperation1, class BinaryOperation2> constexpr // since C++20 T inner_product(InputIt1 first1, InputIt1 last1, InputIt2 first2, T init, BinaryOperation1 op1 BinaryOperation2 op2) { while (first1 != last1) { init = op1(std::move(init), op2(*first1, *first2)); // std::move since C++20 ++first1; ++first2; } return init; }

Notes

The parallelizable version of this algorithm, std::transform_reduce, requires op1 and op2 to be commutative and associative, but std::inner_product makes no such requirement, and always performs the operations in the order given.

Example

Run this code

#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<>(), std::equal_to<>());
    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

transform_reduce (C++17)	applies an invocable, then reduces out of order (function template)
accumulate	sums up a range of elements (function template)
partial_sum	computes the partial sum of a range of elements (function template)