std::ranges:: fold_left

From cppreference.net

ヘッダーで定義 `<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 / = / 説明を参照 */ ;			(3)	( 説明専用* )

左- 畳み込みを指定された範囲の要素に対して実行します。つまり、連鎖式の評価結果を返します：
f(f(f(f(init, x ₁ ), x ₂ ), ...), x _n ) 、ここで x ₁ 、 x ₂ 、...、 x _n は範囲の要素です。

非公式には、 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) (1) と同様であるが、 r を範囲として使用する点が異なる。これは 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)	( 説明専用* )

このページで説明されている関数ライクなエンティティは、 アルゴリズム関数オブジェクト （非公式には niebloids として知られる）です。すなわち：

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

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;

計算量

正確に ranges:: distance ( first, last ) 回、関数オブジェクト f を適用します。

注記

以下の表は、すべての制約付き折りたたみアルゴリズムを比較したものです：

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

機能テストマクロ	値	標準	機能
`__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';
    // ベクター内のすべてのペアのstd::pair::secondの積を取得:
    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';
    // プログラム定義の関数オブジェクト（ラムダ式）を使用:
    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 畳み込み [alg.fold]

Compiler support
Freestanding and hosted
Language
Standard library
Standard library headers
Named requirements
Feature test macros (C++20)
Language support library
Concepts library (C++20)
Diagnostics library
Memory management library
Metaprogramming library (C++11)
General utilities library
Containers library
Iterators library
Ranges library (C++20)
Algorithms library
Strings library
Text processing library
Numerics library
Date and time library
Input/output library
Filesystem library (C++17)
Concurrency support library (C++11)
Execution control library (C++26)
Technical specifications
Symbols index
External libraries

first, last	-	要素の範囲を定義するイテレータ-センチネルペア
r	-	畳み込み対象の要素範囲
init	-	畳み込みの初期値
f	-	二項関数オブジェクト

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

cppreference.net

Namespaces

Variants

std::ranges:: fold_left

目次

パラメータ

戻り値

実装例

計算量

注記

例

参考文献

関連項目