std::ranges::fold_left

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

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

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

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

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

アルゴリズムライブラリ

制約付きアルゴリズムとRangeアルゴリズム (C++20)
制約付きアルゴリズム、例: ranges::copy, ranges::sort, ...
実行ポリシー (C++17)
is_execution_policy (C++17)   execution::seqexecution::parexecution::par_unseqexecution::unseq (C++17)    (C++17)(C++17)(C++20)	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policyexecution::parallel_unsequenced (C++17)(C++17)(C++17)(C++20)
シーケンスを変更しない操作 一括操作 for_each for_each_n (C++17) 検索操作 all_ofany_ofnone_of (C++11)                (C++11)(C++11) countcount_if mismatch equal findfind_iffind_if_not (C++11) find_end find_first_of adjacent_find search search_n シーケンスを変更する操作 コピー操作 copycopy_if (C++11) copy_backward copy_n (C++11) move (C++11) move_backward (C++11) スワップ操作 swap iter_swap swap_ranges 変換操作 replacereplace_if transform replace_copyreplace_copy_if 生成操作 fill fill_n generate generate_n 削除操作 removeremove_if unique remove_copyremove_copy_if unique_copy 順序変更操作 reverse reverse_copy rotate rotate_copy random_shuffleshuffle (C++17まで)(C++11) shift_leftshift_right (C++20)(C++20) サンプリング操作 sample (C++17)	ソートおよび関連操作 パーティション操作 partition partition_copy (C++11)   stable_partition is_partitioned (C++11) partition_point (C++11) ソート操作 sort stable_sort partial_sort partial_sort_copy is_sorted (C++11) is_sorted_until (C++11) nth_element 二分探索操作 (パーティション化された範囲) lower_bound upper_bound equal_range binary_search 集合操作 (ソート済み範囲) includes set_union set_intersection set_difference set_symmetric_difference マージ操作 (ソート済み範囲) merge inplace_merge ヒープ操作 push_heap pop_heap make_heap sort_heap is_heap (C++11) is_heap_until (C++11) 最小/最大操作 max min minmax (C++11) clamp (C++17) max_element min_element minmax_element (C++11) 辞書順比較操作 lexicographical_compare lexicographical_compare_three_way (C++20) 順列操作 next_permutation prev_permutation is_permutation (C++11) Cライブラリ qsort bsearch
数値演算
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)
未初期化メモリに対する操作
uninitialized_copy uninitialized_move (C++17)    uninitialized_fill uninitialized_copy_n (C++11) uninitialized_move_n (C++17) uninitialized_fill_n	destroy (C++17) destroy_n (C++17) destroy_at (C++17) construct_at (C++20)       uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17)

 

制約付きアルゴリズム

このメニューのすべての名前は名前空間 `std::ranges` に属します

シーケンスを変更しない操作

all_ofany_ofnone_of for_each for_each_n    countcount_if adjacent_find mismatch equal lexicographical_compare    containscontains_subrange (C++23)(C++23) findfind_iffind_if_not find_lastfind_last_iffind_last_if_not (C++23)(C++23)(C++23)   find_end find_first_of search search_n starts_with (C++23) ends_with (C++23)

シーケンスを変更する操作

copycopy_if copy_n copy_backward    move move_backward shift_leftshift_right (C++23)(C++23)   fill fill_n generate generate_n    transform swap_ranges    shuffle sample removeremove_if replacereplace_if reverse rotate remove_copyremove_copy_if    unique replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy

パーティション操作

is_partitioned    partition_point    partition    partition_copy    stable_partition

ソート操作

is_sorted is_sorted_until     sort stable_sort         partial_sort       nth_element partial_sort_copy

二分探索操作 (ソート済み範囲)

lower_bound         upper_bound         binary_search      equal_range

集合操作 (ソート済み範囲)

merge inplace_merge       set_difference set_intersection    set_union          includes set_symmetric_difference

ヒープ操作

is_heap is_heap_until       make_heap           sort_heap push_heap pop_heap

最小/最大操作

max max_element         min min_element         minmax minmax_element     clamp

順列操作

is_permutation      next_permutation    prev_permutation

畳み込み操作

fold_left (C++23) fold_left_first (C++23)   fold_right (C++23) fold_right_last (C++23)   fold_left_with_iter (C++23) fold_left_first_with_iter (C++23)

数値演算 iota (C++23)             乱数生成 generate_random (C++26)

未初期化ストレージに対する操作

construct_at    destroy destroy_n destroy_at uninitialized_copy    uninitialized_move uninitialized_fill uninitialized_copy_n    uninitialized_move_n uninitialized_fill_n uninitialized_default_construct uninitialized_default_construct_n uninitialized_value_construct uninitialized_value_construct_n

戻り値の型

in_fun_result in_in_result in_found_result    in_out_result in_in_out_result    in_out_out_result    min_max_result out_value_result (C++23) in_value_result (C++23)

 

ヘッダー <algorithm> で定義
呼び出しシグネチャ
	(1)
template< std::input_iterator I, std::sentinel_for<I> S, class T,           /* indirectly-binary-left-foldable */<T, I> F > constexpr auto fold_left( I first, S last, T init, F f );			(C++23から) (C++26まで)
template< std::input_iterator I, std::sentinel_for<I> S,           class T = std::iter_value_t<I>,           /* indirectly-binary-left-foldable */<T, I> F > constexpr auto fold_left( I first, S last, T init, F f );			(C++26以降)
		(2)
template< ranges::input_range R, class T,           /* indirectly-binary-left-foldable */               <T, ranges::iterator_t<R>> F > constexpr auto fold_left( R&& r, T init, F f );				(C++23から) (C++26まで)
template< ranges::input_range R, class T = ranges::range_value_t<R>,           /* indirectly-binary-left-foldable */               <T, ranges::iterator_t<R>> F > constexpr auto fold_left( R&& r, T init, F f );				(C++26以降)
ヘルパーコンセプト
template< class F, class T, class I > concept /* indirectly-binary-left-foldable */ = /* see description */;			(3)	(説明用*)

与えられた範囲の要素を左畳み込みます。つまり、以下の連鎖式の評価結果を返します。
f(f(f(f(init, x1), x2), ...), xn)、ここで x1、x2、...、xn は範囲の要素です。

非公式には、`ranges::fold_left` は二項述語を受け入れる `std::accumulate` のオーバーロードのように動作します。

`[first, last)` が有効な範囲でない場合、動作は未定義です。

1) 範囲は `[first, last)` です。`return ranges::fold_left_with_iter(std::move(first), last, std::move(init), f).value` と同等です。

2) `r` を範囲として使用することを除き、`(1)` と同じです。これは、`ranges::begin(r)` を `first` として、`ranges::end(r)` を `last` として使用するかのようです。

3) 以下と同等です

ヘルパーコンセプト
template< class F, class T, class I, class U > concept /*indirectly-binary-left-foldable-impl*/ =     std::movable<T> &&     std::movable<U> &&     std::convertible_to<T, U> &&     std::invocable<F&, U, std::iter_reference_t<I>> &&     std::assignable_from<U&,         std::invoke_result_t<F&, U, std::iter_reference_t<I>>>;	(3A)	(説明用*)
template< class F, class T, class I > concept /*indirectly-binary-left-foldable*/ =     std::copy_constructible<F> &&     std::indirectly_readable<I> &&     std::invocable<F&, T, std::iter_reference_t<I>> &&     std::convertible_to<std::invoke_result_t<F&, T, std::iter_reference_t<I>>,         std::decay_t<std::invoke_result_t<F&, T, std::iter_reference_t<I>>>> &&     /*indirectly-binary-left-foldable-impl*/<F, T, I,         std::decay_t<std::invoke_result_t<F&, T, std::iter_reference_t<I>>>>;	(3B)	(説明用*)

このページで説明されている関数のようなエンティティは、アルゴリズム関数オブジェクト（非公式にはニーブロイドとして知られている）です。つまり、

• これらのいずれかを呼び出す際に、明示的なテンプレート引数リストを指定することはできません。
• これらのいずれも実引数依存の名前探索には見えません。
• これらのいずれかが関数呼び出し演算子の左側の名前として通常の非修飾名探索によって見つかった場合、実引数依存の名前探索は抑制されます。

パラメーター

first, last	-	畳み込みを行う要素の範囲を定義するイテレーターと番兵のペア
r	-	畳み込みを行う要素の範囲
init	-	畳み込みの初期値
f	-	二項関数オブジェクト

戻り値

与えられた範囲を `f` を使って左畳み込みした結果を含む型 `U` のオブジェクト。ここで `U` は `std::decay_t>>` と同等です。

範囲が空の場合、`U(std::move(init))` が返されます。

可能な実装

struct fold_left_fn { template<std::input_iterator I, std::sentinel_for<I> S, class T = std::iter_value_t<I>, /* indirectly-binary-left-foldable */<T, I> F> constexpr auto operator()(I first, S last, T init, F f) const { using U = std::decay_t<std::invoke_result_t<F&, T, std::iter_reference_t<I>>>; if (first == last) return U(std::move(init)); U accum = std::invoke(f, std::move(init), *first); for (++first; first != last; ++first) accum = std::invoke(f, std::move(accum), *first); return std::move(accum); }   template<ranges::input_range R, class T = ranges::range_value_t<R>, /* indirectly-binary-left-foldable */<T, ranges::iterator_t<R>> F> constexpr auto operator()(R&& r, T init, F f) const { return (*this)(ranges::begin(r), ranges::end(r), std::move(init), std::ref(f)); } };   inline constexpr fold_left_fn fold_left;

計算量

関数オブジェクト `f` の適用回数は、厳密に `ranges::distance(first, last)` です。

備考

以下の表は、すべての制約付き畳み込みアルゴリズムを比較しています。

畳み込み関数テンプレート	開始位置	初期値	戻り値の型
ranges::fold_left	left	init	U
ranges::fold_left_first	left	最初の要素	std::optional<U>
ranges::fold_right	right	init	U
ranges::fold_right_last	right	最後の要素	std::optional<U>
ranges::fold_left_with_iter	left	init	(1) ranges::in_value_result<I, U> (2) ranges::in_value_result<BR, U>, ここで `BR` は `ranges::borrowed_iterator_t` です
ranges::fold_left_first_with_iter	left	最初の要素	(1) ranges::in_value_result<I, std::optional<U>> (2) ranges::in_value_result<BR, std::optional<U>> ここで `BR` は `ranges::borrowed_iterator_t` です

機能テストマクロ	値	規格	機能
__cpp_lib_ranges_fold	202207L	(C++23)	std::ranges 畳み込みアルゴリズム
__cpp_lib_algorithm_default_value_type	202403L	(C++26)	アルゴリズム (1,2) のためのリスト初期化

例

このコードを実行

#include <algorithm>
#include <complex>
#include <functional>
#include <iostream>
#include <ranges>
#include <string>
#include <utility>
#include <vector>
 
int main()
{
    namespace ranges = std::ranges;
 
    std::vector v{1, 2, 3, 4, 5, 6, 7, 8};
 
    int sum = ranges::fold_left(v.begin(), v.end(), 0, std::plus<int>()); // (1)
    std::cout << "sum: " << sum << '\n';
 
    int mul = ranges::fold_left(v, 1, std::multiplies<int>()); // (2)
    std::cout << "mul: " << mul << '\n';
 
    // get the product of the std::pair::second of all pairs in the vector:
    std::vector<std::pair<char, float>> data {{'A', 2.f}, {'B', 3.f}, {'C', 3.5f}};
    float sec = ranges::fold_left
    (
        data | ranges::views::values, 2.0f, std::multiplies<>()
    );
    std::cout << "sec: " << sec << '\n';
 
    // use a program defined function object (lambda-expression):
    std::string str = ranges::fold_left
    (
        v, "A", [](std::string s, int x) { return s + ':' + std::to_string(x); }
    );
    std::cout << "str: " << str << '\n';
 
    using CD = std::complex<double>;
    std::vector<CD> nums{{1, 1}, {2, 0}, {3, 0}};
    #ifdef __cpp_lib_algorithm_default_value_type
        auto res = ranges::fold_left(nums, {7, 0}, std::multiplies{}); // (2)
    #else
        auto res = ranges::fold_left(nums, CD{7, 0}, std::multiplies{}); // (2)
    #endif
    std::cout << "res: " << res << '\n';
}

出力

sum: 36
mul: 40320
sec: 42
str: A:1:2:3:4:5:6:7:8
res: (42,42)

参照

• C++23標準 (ISO/IEC 14882:2024)

• 27.6.18 Fold [alg.fold]

関連項目

ranges::fold_left_first (C++23)	最初の要素を初期値として要素の範囲を左畳み込みする (アルゴリズム関数オブジェクト)
ranges::fold_right (C++23)	要素の範囲を右畳み込みする (アルゴリズム関数オブジェクト)
ranges::fold_right_last (C++23)	最後の要素を初期値として要素の範囲を右畳み込みする (アルゴリズム関数オブジェクト)
ranges::fold_left_with_iter (C++23)	要素の範囲を左畳み込みし、ペア (イテレータ, 値) を返す (アルゴリズム関数オブジェクト)
ranges::fold_left_first_with_iter (C++23)	最初の要素を初期値として要素の範囲を左畳み込みし、ペア (イテレータ, optional) を返す (アルゴリズム関数オブジェクト)
accumulate	範囲の要素を合計または畳み込む (関数テンプレート)
reduce (C++17)	std::accumulate に似ているが、順序不同 (関数テンプレート)