std::inner_product

提供: cppreference.com

ヘッダ `<numeric>` で定義
	(1)
template< class InputIt1, class InputIt2, class T > T inner_product( InputIt1 first1, InputIt1 last1, InputIt2 first2, T init );			(C++20未満)
template< class InputIt1, class InputIt2, class T > constexpr T inner_product( InputIt1 first1, InputIt1 last1, InputIt2 first2, T init );			(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 );				(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 );				(C++20以上)

範囲 [first1, last1) および first2 から始まる範囲の内積 (積の和) の計算、または順序付けされた map/reduce 操作を行います。

1) 累積変数 acc を初期値 init で初期化し、 last1 に達するまで、

それを式 acc = acc + first1 first2 で変更し、その後、式 acc = acc + (first1+1) * *(first2+1) で再び変更し、以下同様です。	(C++20未満)
それを式 acc = std::move(acc) + first1 first2 で変更し、その後、式 acc = std::move(acc) + (first1+1) * *(first2+1) で再び変更し、以下同様です。	(C++20以上)

+ および * の組み込みの意味の場合、これは2つの範囲の内積を計算します。

2) 累積変数 acc を初期値 init で初期化し、 last1 に達するまで、

それを式 acc = op1(acc, op2(first1, first2)) で変更し、その後、式 acc = op1(acc, op2((first1+1), (first2+1))) で再び変更し、以下同様です。	(C++20未満)
それを式 acc = op1(std::move(acc), op2(first1, first2)) で変更し、その後、式 acc = op1(std::move(acc), op2((first1+1), (first2+1))) で再び変更し、以下同様です。	(C++20以上)

`op1` および `op2` は副作用を持っていてはなりません。	(C++11未満)
`op1` および `op2` は終端イテレータを含むいかなるイテレータも無効化してはならず、関係する範囲のいかなる要素も変更してはなりません。	(C++11以上)

first1, last1	-	1つめの要素の範囲
first2	-	2つめの要素の範囲の先頭
init	-	積を加算する初期値
op1	-	適用される二項演算関数オブジェクト。この「加算」関数は、 op2 から返された値と、累積変数の現在の値を取り、累積変数に格納される新しい値を生成します。関数のシグネチャは以下と同等であるべきです。 Ret fun(const Type1 &a, const Type2 &b); シグネチャが const & を持つ必要はありません。型 Type1 および Type2 は、それぞれ T および Type3 型のオブジェクトから暗黙に変換可能なものでなければなりません。型 Ret は T 型のオブジェクトに代入可能なものでなければなりません。
op2	-	適用される二項演算関数オブジェクト。この「乗算」関数は、それぞれの範囲から値を1つずつ取り、新しい値を生成します。関数のシグネチャは以下と同等であるべきです。 Ret fun(const Type1 &a, const Type2 &b); シグネチャが const & を持つ必要はありません。型 Type1 および Type2 は、 InputIt1 および InputIt2 型のオブジェクトの逆参照からType1 および Type2 にそれぞれ暗黙に変換可能なものでなければなりません。型 Ret は Type3 型のオブジェクトに代入可能なものでなければなりません。
型の要件
- `InputIt1, InputIt2` は LegacyInputIterator の要件を満たさなければなりません。
- `ForwardIt1, ForwardIt2` は LegacyForwardIterator の要件を満たさなければなりません。
- `T` は CopyAssignable および CopyConstructible の要件を満たさなければなりません。

[編集] 戻り値

上で説明した通りの acc の最終値。

[編集] 実装例

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

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++20
         ++first1;
         ++first2;
    }
    return init;
}

[編集] ノート

このアルゴリズムの並列化バージョン std::transform_reduce では、 op1 および op2 が交換法則と結合法則を満たすことが要求されますが、 std::inner_product にはそのような要件はなく、常に指定された順序で演算を行います。

[編集] 例

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

出力:

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

[編集] 関連項目

transform_reduce (C++17)	不定の計算順序で、関数オブジェクトを適用した結果を reduce します (関数テンプレート) [edit]
accumulate	指定範囲の要素を合計します (関数テンプレート) [edit]
partial_sum	指定範囲の要素の部分和を計算します (関数テンプレート) [edit]

「https://ja.cppreference.com/mwiki/index.php?title=cpp/algorithm/inner_product&oldid=46611」から取得

言語
標準ライブラリヘッダ
フリースタンディング処理系とホスト処理系
名前付き要件
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
ユーティリティライブラリ
文字列ライブラリ
コンテナライブラリ
イテレータライブラリ
範囲ライブラリ (C++20)
アルゴリズムライブラリ
数値演算ライブラリ
ローカライゼーションライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
正規表現ライブラリ (C++11)
アトミック操作ライブラリ (C++11)
スレッドサポートライブラリ (C++11)
技術仕様書

cppreference.com

名前空間

変種

表示

操作