命名空间
变体
操作

std::inner_product

来自 cppreference.com
< cpp‎ | algorithm
 
 
算法库
约束算法和范围上的算法 (C++20)
约束算法,例如 ranges::copy, ranges::sort, ...
执行策略 (C++17)
排序和相关操作
分区操作
排序操作
二分搜索操作
(在已分区范围内)
集合操作(在排序的范围内)
合并操作(在排序的范围内)
堆操作
最小/最大操作
(C++11)
(C++17)
字典序比较操作
排列操作
C 库
数值操作
(C++11)
inner_product
未初始化内存上的操作
 
 
定义在头文件 <numeric>
template< class InputIt1, class InputIt2, class T >

T inner_product( InputIt1 first1, InputIt1 last1,

                 InputIt2 first2, T init );
(1) (从 C++20 开始支持 constexpr)
template< class InputIt1, class InputIt2, class T,

          class BinaryOp1, class BinaryOp2 >
T inner_product( InputIt1 first1, InputIt1 last1,
                 InputIt2 first2, T init,

                 BinaryOp1 op1, BinaryOp2 op2 );
(2) (从 C++20 开始支持 constexpr)

计算内积(即乘积之和)或对范围 [first1last1) 和以 std::distance(first1, last1) 个元素开始的范围 first2 执行有序的映射/归约操作。

1) 用初始值 init 初始化累加器 acc(类型为 T),然后用表达式 acc = acc + (*i1) * (*i2)(直到 C++20)acc = std::move(acc) + (*i1) * (*i2)(从 C++20 开始) 对范围 [first1last1) 中的每个迭代器 i1 及其在以 first2 开始的范围中的对应迭代器 i2 按顺序进行修改。对于 + 和 * 的内置含义,这计算了两个范围的内积。
2) 用初始值 init 初始化累加器 acc(类型为 T),然后用表达式 acc = op1(acc, op2(*i1, *i2))(直到 C++20)acc = op1(std::move(acc), op2(*i1, *i2))(从 C++20 开始) 对范围 [first1last1) 中的每个迭代器 i1 及其在以 first2 开始的范围中的对应迭代器 i2 按顺序进行修改。

给定 last2 作为 std::distance(first1, last1)
th
first2 的下一个迭代器(如果有),如果满足以下任一条件,则行为未定义

  • T 不是 可复制构造
  • T 不是 CopyAssignable
  • op1op2 修改了 [first1last1)[first2last2) 中的任何元素。
  • op1op2 使 [first1last1][first2last2] 中的任何迭代器或子范围失效。

内容

[编辑] 参数

first1, last1 - 第一个元素范围
first2 - 第二个元素范围的起始位置
init - 乘积之和的初始值
op1 - 将要应用的二元操作函数对象。此“求和”函数接受 op2 返回的值和累加器的当前值,并生成一个新的值来存储在累加器中。

函数的签名应该等效于以下内容

 Ret fun(const Type1 &a, const Type2 &b);

签名不需要有 const &
类型  Type1 Type2 必须使类型 TType3 的对象可以隐式转换为  Type1 Type2。类型 Ret 必须使类型 T 的对象可以被赋值为类型 Ret 的值。​

op2 - 将要应用的二元操作函数对象。此“乘积”函数从每个范围中获取一个值,并生成一个新的值。

函数的签名应该等效于以下内容

 Ret fun(const Type1 &a, const Type2 &b);

签名不需要有 const &
类型  Type1 Type2 必须使类型 InputIt1InputIt2 的对象可以被解引用,然后隐式转换为  Type1 Type2。类型 Ret 必须使类型 Type3 的对象可以被赋值为类型 Ret 的值。​

类型要求
-
InputIt1, InputIt2 必须满足 LegacyInputIterator 的要求。
-
ForwardIt1, ForwardIt2 必须满足 LegacyForwardIterator 的要求。

[编辑] 返回值

在所有修改之后 acc 的值。

[编辑] 可能的实现

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

[编辑] 注释

此算法的可并行版本,std::transform_reduce,要求 op1op2 必须是可交换的和可结合的,但是 std::inner_product 没有这种要求,并且始终按给定的顺序执行操作。

[编辑] 示例

#include <functional>
#include <iostream>
#include <numeric>
#include <vector>
 
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';
}

输出

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

[编辑] 缺陷报告

以下行为更改缺陷报告已追溯应用于先前发布的 C++ 标准。

DR 应用于 已发布的行为 正确行为
LWG 242 C++98 op1op2 不能有副作用 它们不能修改所涉及的范围

[编辑] 参见

应用一个可调用对象,然后无序地进行归约
(函数模板) [编辑]
对元素范围求和或折叠
(函数模板) [编辑]
计算元素范围的局部和
(函数模板) [编辑]