std::inner_product

 

C++

言語

ヘッダ

コンセプト

言語サポートライブラリ

診断ライブラリ

ユーティリティライブラリ

文字列ライブラリ

コンテナライブラリ

アルゴリズムライブラリ

イテレータライブラリ

数値演算ライブラリ

入出力ライブラリ

ローカライゼーションライブラリ

正規表現ライブラリ(C++11)

アトミック操作ライブラリ(C++11)

スレッドサポートライブラリ(C++11)

ファイルシステムライブラリ(C++17)

技術仕様書

 

アルゴリズムライブラリ

実行ポリシー (C++17)
is_execution_policy	execution::seqexecution::parexecution::par_unseq	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policy
非変更シーケンス操作
all_ofany_ofnone_of (C++11)(C++11)(C++11) for_each for_each_n (C++17)	countcount_if mismatch equal adjacent_find	findfind_iffind_if_not (C++11) find_end find_first_of	search search_n lexicographical_compare lexicographical_compare_3way (C++20)
変更シーケンス操作
copycopy_if (C++11) copy_n (C++11) copy_backward move (C++11) move_backward (C++11) transform	fill fill_n generate generate_n swap iter_swap swap_ranges sample (C++17)	removeremove_if replacereplace_if reverse rotate unique random_shuffle (C++17以前)	remove_copyremove_copy_if replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy shuffle (C++11)
未初期化記憶域の操作
uninitialized_copy uninitialized_move (C++17)	uninitialized_copy_n (C++11) uninitialized_move_n (C++17)	uninitialized_fill	uninitialized_fill_n
分割操作
is_partitioned (C++11) partition_point (C++11)	partition partition_copy (C++11)	stable_partition
ソート操作
is_sorted (C++11) is_sorted_until (C++11)	sort stable_sort	partial_sort partial_sort_copy	nth_element
バイナリサーチ操作
lower_bound	upper_bound	binary_search	equal_range
集合操作 (ソート済み範囲用)
merge inplace_merge	set_difference set_intersection	set_symmetric_difference set_union	includes
ヒープ操作
is_heap (C++11) is_heap_until (C++11)	make_heap sort_heap	push_heap pop_heap
最小/最大演算
max max_element	min min_element	minmax (C++11) minmax_element (C++11)	clamp (C++17) compare_3way (C++20)
順列
is_permutation (C++11)	next_permutation	prev_permutation
数値演算
iota (C++11) inner_product adjacent_difference	accumulate reduce (C++17) transform_reduce (C++17)	partial_sum inclusive_scan (C++17) exclusive_scan (C++17)	transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)
C のライブラリ
qsort	bsearch

 

ヘッダ <numeric> で定義
template<class InputIt1, class InputIt2, class T > T inner_product( InputIt1 first1, InputIt1 last1,                  InputIt2 first2, T value );	(1)
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 );	(2)

範囲 [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つめの要素の範囲の先頭
value	-	積を加算する初期値
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 は InputIterator の要件を満たさなければなりません。
- ForwardIt1, ForwardIt2 は ForwardIterator の要件を満たさなければなりません。
- T は CopyAssignable および CopyConstructible の要件を満たさなければなりません。

戻り値

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

実装例

1つめのバージョン
template<class InputIt1, class InputIt2, class T> T inner_product(InputIt1 first1, InputIt1 last1, InputIt2 first2, T value){while(first1 != last1){ value = std::move(value)+*first1 **first2;// std::move since C++20++first1;++first2;}return value;}
2つめのバージョン
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(std::move(value), op2(*first1, *first2));// std::move since C++20++first1;++first2;}return value;}

ノート

このアルゴリズムの並列化バージョン 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 します (関数テンプレート)
accumulate	指定範囲の要素を合計します (関数テンプレート)
partial_sum	指定範囲の要素の部分和を計算します (関数テンプレート)