Namespaces
Variants
Views
Actions

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

From cppreference.com
< cpp‎ | algorithm
(+)
Line 3: Line 3:
 
{{dcl begin}}
 
{{dcl begin}}
 
{{dcl header | numeric}}
 
{{dcl header | numeric}}
−
{{dcl | num=1 |
+
{{dcl | since= | num= 1 |1=
 
template< class InputIt1, class InputIt2, class T >
 
template< class InputIt1, class InputIt2, class T >
 
T inner_product( InputIt1 first1, InputIt1 last1,
 
T inner_product( InputIt1 first1, InputIt1 last1,
 
                 InputIt2 first2, T value );
 
                 InputIt2 first2, T value );
 
}}
 
}}
−
{{dcl | num=2 |
+
{{dcl | since=c++17 | num= 2 |1=
 +
template< class ExecutionPolicy, class InputIt1, class InputIt2, class T >
 +
T inner_product( ExecutionPolicy&& policy, InputIt1 first1, InputIt1 last1,
 +
                InputIt2 first2, T value );}}
 +
{{dcl | since= | num= 3 |1=
 
template<class InputIt1, class InputIt2, class T,
 
template<class InputIt1, class InputIt2, class T,
 
         class BinaryOperation1, class BinaryOperation2>  
 
         class BinaryOperation1, class BinaryOperation2>  
Line 16: Line 20:
 
                 BinaryOperation2 op2 );
 
                 BinaryOperation2 op2 );
 
}}
 
}}
 +
{{dcl | since=c++17 | num= 4 |1=
 +
template< class ExecutionPolicy,class InputIt1, class InputIt2, class T,
 +
        class BinaryOperation1, class BinaryOperation2>
 +
T inner_product( ExecutionPolicy&& policy, InputIt1 first1, InputIt1 last1,
 +
                InputIt2 first2, T value,
 +
                BinaryOperation1 op1,
 +
                BinaryOperation2 op2 );}}
 
{{dcl end}}
 
{{dcl end}}
  
 
Computes inner product (i.e. sum of products) of the range {{tt|[first1, last1)}} and another range beginning at {{tt|first2}}. The first version uses {{tt|operator*}} to compute product of the element pairs and {{tt|operator+}} to sum up the products, the second version uses {{tt|op2}} and {{tt|op1}} for these tasks respectively.
 
Computes inner product (i.e. sum of products) of the range {{tt|[first1, last1)}} and another range beginning at {{tt|first2}}. The first version uses {{tt|operator*}} to compute product of the element pairs and {{tt|operator+}} to sum up the products, the second version uses {{tt|op2}} and {{tt|op1}} for these tasks respectively.
  
 +
@1@ Products are calculated using {{tt|operator*}} and sums are calculated using {{tt|operator+}}.
 +
@3@ Products are calculated using {{tt|op2}} and sums are calculated using {{tt|op1}}.
 +
@2,4@ Same as {{v|1,3}}, but executed according to {{tt|policy}}. These overloads do not participate in overload resolution unless {{c|std::is_execution_policy_v<std::decay_t<ExecutionPolicy>>}} is true
 
{{rev begin}}
 
{{rev begin}}
 
{{rev | until=c++11 |
 
{{rev | until=c++11 |
Line 34: Line 48:
 
{{par | first2 | the beginning of the second range of elements}}
 
{{par | first2 | the beginning of the second range of elements}}
 
{{par | value | initial value of the sum of the products}}
 
{{par | value | initial value of the sum of the products}}
 +
{{par exec pol}}
 
{{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 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}}
Line 43: Line 58:
 
===Return value===
 
===Return value===
 
The inner product of two ranges.
 
The inner product of two ranges.
 +
 +
===Exceptions===
 +
{{cpp/algorithm/parallel_exceptions_reporting_behavior|singular=no}}
  
 
===Possible implementation===
 
===Possible implementation===

Revision as of 09:38, 21 March 2016

 
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>
template< class InputIt1, class InputIt2, class T >

T inner_product( InputIt1 first1, InputIt1 last1,

                 InputIt2 first2, T value );
 (1)
template< class ExecutionPolicy, class InputIt1, class InputIt2, class T >

T inner_product( ExecutionPolicy&& policy, InputIt1 first1, InputIt1 last1,

                 InputIt2 first2, T value );
 (2) (since C++17)
template<class InputIt1, class InputIt2, class T,

         class BinaryOperation1, class BinaryOperation2>
T inner_product( InputIt1 first1, InputIt1 last1,
                 InputIt2 first2, T value,
                 BinaryOperation1 op1,

                 BinaryOperation2 op2 );
 (3)
template< class ExecutionPolicy,class InputIt1, class InputIt2, class T,

         class BinaryOperation1, class BinaryOperation2>
T inner_product( ExecutionPolicy&& policy, InputIt1 first1, InputIt1 last1,
                 InputIt2 first2, T value,
                 BinaryOperation1 op1,

                 BinaryOperation2 op2 );
 (4) (since C++17)

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.

1) Products are calculated using operator* and sums are calculated using operator+.
3) Products are calculated using op2 and sums are calculated using op1.
2,4) Same as (1,3), but executed according to policy. These overloads do not participate in overload resolution unless std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> is true

op1 and op2 must not have side effects.

(until C++11)

op1 and op2 must not invalidate any iterators, including the end iterators, or modify any elements of the ranges involved.

(since C++11)

Contents

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
policy - the execution policy to use. See execution policy for details.
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

Template:par req concept Template:par req concept

Return value

The inner product of two ranges.

Exceptions

The overloads with a template parameter named ExecutionPolicy report errors as follows:

  • If execution of a function invoked as part of the algorithm throws an exception and ExecutionPolicy is one of the standard policies, std::terminate is called. For any other ExecutionPolicy, the behavior is implementation-defined.
  • If the algorithm fails to allocate memory, std::bad_alloc is thrown.

Possible implementation

First version 
template<class InputIt1, class InputIt2, class T>
T inner_product(InputIt1 first1, InputIt1 last1,
                InputIt2 first2, T value)
{
    while (first1 != last1) {
         value = value + *first1 * *first2;
         ++first1;
         ++first2;
    }
    return value;
}
Second version 
template<class InputIt1, class InputIt2,
         class T,
         class BinaryOperation1, class BinaryOperation2>
T inner_product(InputIt1 first1, InputIt1 last1,
                InputIt2 first2, T value,
                BinaryOperation1 op1
                BinaryOperation2 op2)
{
    while (first1 != last1) {
         value = op1(value, op2(*first1, *first2));
         ++first1;
         ++first2;
    }
    return value;
}

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

 sums up or folds a range of elements
(function template) [edit]
computes the partial sum of a range of elements
(function template) [edit]
(parallelism TS)
 parallelized version of std::inner_product
(function template) [edit]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/algorithm/inner_product&oldid=84667"