std::inner_product

Определён в заголовочном файле <numeric>

Определён в заголовочном файле `<numeric>`
template< class InputIt1, class InputIt2, class T > T inner_product( InputIt1 first1, InputIt1 last1, InputIt2 first2, T init );	(1)	(constexpr с C++20)
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)	(constexpr с C++20)

template< class InputIt1, class InputIt2, class T >
T inner_product( InputIt1 first1, InputIt1 last1,
                 InputIt2 first2, T init );

(1)

(constexpr с C++20)

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)

(constexpr с C++20)

Вычисляет скалярное произведение (то есть сумму произведений) или выполняет упорядоченную операцию отображения/свёртки над диапазоном [first1, last1) и диапазоном из std::distance(first1, last1) элементов, начинающимся с first2.

1) Инициализирует аккумулятор acc (типа T) начальным значением init, а затем изменяет его с помощью выражения acc = acc + (*i1) * (*i2)(до C++20)acc = std::move(acc) + (*i1) * (*i2)(с C++20) для каждого итератора i1 в диапазоне [first1, last1) по порядку и соответствующего ему итератора i2 в диапазоне, начинающемся с first2. При встроенном смысле операций + и * вычисляется скалярное произведение двух диапазонов.

2) Инициализирует аккумулятор acc (типа T) начальным значением init, а затем изменяет его с помощью выражения acc = op1(acc, op2(*i1, *i2))(до C++20)acc = op1(std::move(acc), op2(*i1, *i2))(с C++20) для каждого итератора i1 в диапазоне [first1, last1) по порядку и соответствующего ему итератора i2 в диапазоне, начинающемся с first2.

Пусть last2 — итератор, следующий за first2 на std::distance(first1, last1) позиций. Если выполняется хотя бы одно из следующих условий, поведение не определено:

T не удовлетворяет требованиям CopyConstructible.
T не удовлетворяет требованиям CopyAssignable.
op1 или op2 изменяет какой-либо элемент [first1, last1) или [first2, last2).
op1 или op2 делает недействительным любой итератор или поддиапазон в [first1, last1] или [first2, last2].

Параметры

first1, last1	-	пара итераторов, задающая диапазон элементов для обработки
first2	-	начало второго диапазона элементов
init	-	начальное значение суммы произведений
op1	-	применяемый объект-функция бинарной операции. Эта функция «суммирования» принимает значение, возвращённое `op2`, и текущее значение аккумулятора и формирует новое значение, которое будет сохранено в аккумуляторе. Сигнатура функции должна быть эквивалентна следующей: Retfun(constType1&a,constType2&b); Сигнатура не обязательно должна содержать `const &`. Типы Type1 и Type2 должны быть такими, чтобы объекты типов T и Type3 можно было неявно преобразовать соответственно в Type1 и Type2. Тип `Ret` должен быть таким, чтобы объекту типа `T` можно было присвоить значение типа `Ret`.
op2	-	применяемый объект-функция бинарной операции. Эта функция «умножения» принимает по одному значению из каждого диапазона и формирует новое значение. Сигнатура функции должна быть эквивалентна следующей: Retfun(constType1&a,constType2&b); Сигнатура не обязательно должна содержать `const &`. Типы Type1 и Type2 должны быть такими, чтобы объекты типов InputIt1 и InputIt2 можно было разыменовать, а полученные значения — неявно преобразовать соответственно в Type1 и Type2. Тип `Ret` должен быть таким, чтобы объекту типа `Type3` можно было присвоить значение типа `Ret`.
Требования к типам
-`InputIt1, InputIt2` должен удовлетворять требованиям LegacyInputIterator.

Возвращаемое значение

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

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, требует, чтобы op1 и op2 были коммутативными и ассоциативными, но 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++.

Отчёт об ошибке	Применён к	Опубликованное поведение	Исправленное поведение
LWG 242	C++98	`op1` и `op2` не могли иметь побочных эффектов	они не могут изменять участвующие диапазоны

См. также

transform_reduce (C++17)	применяет вызываемый объект, а затем выполняет свёртку без заданного порядка (шаблон функции)
accumulate	суммирует или сворачивает диапазон элементов (шаблон функции)
partial_sum	вычисляет частичные суммы диапазона элементов (шаблон функции)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/algorithm/inner_product