Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/algorithm/inner product"

From cppreference.com
< cpp‎ | algorithm
m (→‎Possible implementation: +links)
(Added LWG issue #2055 DR (part 4/4).)
Line 27: Line 27:
 
{{dcl end}}
 
{{dcl end}}
  
−
Computes inner product (i.e. sum of products) or performs ordered map/reduce operation on the range {{tt|[first1, last1)}} and the range beginning at {{c|first2}}.  
+
Computes inner product (i.e. sum of products) or performs ordered map/reduce operation on the range {{range|first1|last1}} and the range beginning at {{c|first2}}.  
  
−
@1@ Initializes the accumulator {{c|acc}} with the initial value {{c|init}} and then
+
@1@ Initializes the accumulator {{c|acc}} with the initial value {{c|init}} and then  
−
{{rrev multi|until1=c++20|rev1=
+
modifies it with the expression {{rev inl|until=c++11|{{c|1=acc = acc + (*i1) * (*i2)}}}}{{rev inl|since=c++11|{{c|1=acc = std::move(acc) + (*i1) * (*i2)}}}} for every iterator {{c|i1}} in the range {{range|first|last}} in order and its corresponding iterator {{c|i2}} in the range beginning at {{c|first2}}. For built-in meaning of + and *, this computes inner product of the two ranges.
−
modifies it with the expression {{c|1=acc = acc + *first1 * *first2}}, then modifies again with the expression {{c|1=acc = acc + *(first1 + 1) * *(first2 + 1)}}, etc
+
 
−
|rev2=
+
@2@ Initializes the accumulator {{c|acc}} with the initial value {{c|init}} and then  
−
modifies it with the expression {{c|1=acc = std::move(acc) + *first1 * *first2}}, then modifies again with the expression {{c|1=acc = std::move(acc) + *(first1 + 1) * *(first2 + 1)}}, etc
+
modifies it with the expression {{rev inl|until=c++11|{{c|1=acc = op1(acc, op2(*i1, *i2))}}}}{{rev inl|since=c++11|{{c|1=acc = op1(std::move(acc), op2(*i1, *i2))}}}} for every iterator {{c|i1}} in the range {{range|first|last}} in order and its corresponding iterator {{c|i2}} in the range beginning at {{c|first2}}.
−
}}
+
−
until reaching {{c|last1}}. For built-in meaning of + and *, this computes inner product of the two ranges.
+
−
@2@ Initializes the accumulator {{c|acc}} with the initial value {{c|init}} and then
+
−
{{rrev multi|until1=c++20|rev1=
+
−
modifies it with the expression {{c|1=acc = op1(acc, op2(*first1, *first2))}}, then modifies again with the expression {{c|1=acc = op1(acc, op2(*(first1 + 1), *(first2 + 1)))}}, etc
+
−
|rev2=
+
−
modifies it with the expression {{c|1=acc = op1(std::move(acc), op2(*first1, *first2))}}, then modifies again with the expression {{c|1=acc = op1(std::move(acc), op2(*(first1 + 1), *(first2 + 1)))}}, etc
+
−
}}
+
−
until reaching {{c|last1}}.
+
  
−
{{c|op1}} and {{c|op2}} must not invalidate any iterators, including the end iterators, or modify any elements of the range involved.
+
If {{c|op1}} or {{c|op2}} invalidates any iterators (including the end iterators) or modify any elements of the range involved, the behavior is undefined.
  
 
===Parameters===
 
===Parameters===
Line 51: Line 42:
 
{{par|first2|the beginning of the second range of elements}}
 
{{par|first2|the beginning of the second range of elements}}
 
{{par|init|initial value of the sum of the products}}
 
{{par|init|initial value of the sum of the products}}
−
{{par op2|op1|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.|t1=T|t2=Type3|rt=T}}
+
{{par op2|op1|This "sum" function takes a value returned by {{c|op2}} and the current value of the accumulator and produces a new value to be stored in the accumulator.|t1=T|t2=Type3|rt=T}}
 
{{par op2|op2|This "product" function takes one value from each range and produces a new value.|p1=InputIt1|p2=InputIt2|rt=Type3}}
 
{{par op2|op2|This "product" function takes one value from each range and produces a new value.|p1=InputIt1|p2=InputIt2|rt=Type3}}
 
{{par hreq}}
 
{{par hreq}}
Line 71: Line 62:
 
     while (first1 != last1)
 
     while (first1 != last1)
 
     {
 
     {
−
         init = std::move(init) + *first1 * *first2; // std::move since C++20
+
         init = std::move(init) + (*first1) * (*first2); // std::move since C++11
 
         ++first1;
 
         ++first1;
 
         ++first2;
 
         ++first2;
Line 89: Line 80:
 
     while (first1 != last1)
 
     while (first1 != last1)
 
     {
 
     {
−
         init = op1(std::move(init), op2(*first1, *first2)); // std::move since C++20
+
         init = op1(std::move(init), op2(*first1, *first2)); // std::move since C++11
 
         ++first1;
 
         ++first1;
 
         ++first2;
 
         ++first2;
Line 129: Line 120:
 
===Defect reports===
 
===Defect reports===
 
{{dr list begin}}
 
{{dr list begin}}
−
{{dr list item|wg=lwg|dr=242|std=C++98|before={{c|op1}} and {{c|op2}} cannot have side effects|after=they cannot modify the ranges involved}}
+
{{dr list item|wg=lwg|dr=242|std=C++98|before={{c|op1}} and {{c|op2}} could not have side effects|after=they cannot modify the ranges involved}}
 +
{{dr list item|wg=lwg|dr=2055|paper=P0616R0|std=C++11|before={{c|acc}} was not moved while being accumulated|after=it is moved}}
 
{{dr list end}}
 
{{dr list end}}
  

Revision as of 23:02, 26 February 2023

 
C++
 
Algorithm library
Constrained algorithms and algorithms on ranges (C++20)
Constrained algorithms, e.g. ranges::copy, ranges::sort, ...
Execution policies (C++17)
Non-modifying sequence operations
Batch operations
(C++17)
Search operations
(C++11)                (C++11)(C++11)

Modifying sequence operations
Copy operations
(C++11)
(C++11)
(C++11)
Swap operations
Transformation operations
Generation operations
Removing operations
Order-changing operations
(until C++17)(C++11)
(C++20)(C++20)
Sampling operations
(C++17)

Sorting and related operations
Partitioning operations
Sorting operations
Binary search operations
(on partitioned ranges)
Set operations (on sorted ranges)
Merge operations (on sorted ranges)
Heap operations
Minimum/maximum operations
(C++11)
(C++17)
Lexicographical comparison operations
(C++20)
Permutation operations
C library
Numeric operations
(C++11)
inner_product
  
Operations on uninitialized memory
 
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 + (*i1) * (*i2)(until C++11)acc = std::move(acc) + (*i1) * (*i2)(since C++11) for every iterator i1 in the range [first, last) in order and its corresponding iterator i2 in the range beginning at first2. 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(*i1, *i2))(until C++11)acc = op1(std::move(acc), op2(*i1, *i2))(since C++11) for every iterator i1 in the range [first, last) in order and its corresponding iterator i2 in the range beginning at first2.

If op1 or op2 invalidates any iterators (including the end iterators) or modify any elements of the range involved, the behavior is undefined.

Contents

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

inner_product (1) 
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++11
         ++first1;
         ++first2;
    }
 
    return init;
}
inner_product (2) 
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++11
         ++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

Defect reports

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 and op2 could not have side effects they cannot modify the ranges involved
LWG 2055
(P0616R0) 		C++11 acc was not moved while being accumulated it is moved

See also

(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]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/algorithm/inner_product&oldid=148635"