std::ranges:: fold_left_with_iter, std::ranges:: fold_left_with_iter_result

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 / see description */ fold_left_with_iter ( 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 / see description */ fold_left_with_iter ( I first, S last, T init, F f ) ;			(C++26以降)
		(2)
template < ranges:: input_range R, class T, /* 間接的に二項左畳み込み可能 / < T, ranges:: iterator_t < R >> F > constexpr / 説明を参照 */ fold_left_with_iter ( R && r, T init, F f ) ;				(C++23以降) (C++26まで)
template < ranges:: input_range R, class T = ranges:: range_value_t < R > , /* 間接的に二項左畳み込み可能 / < T, ranges:: iterator_t < R >> F > constexpr / 説明を参照 */ fold_left_with_iter ( R && r, T init, F f ) ;				(C++26以降)
ヘルパーコンセプト
template < class F, class T, class I > concept /* indirectly-binary-left-foldable / = / see description */ ;			(3)	( 説明専用* )
ヘルパークラステンプレート
template < class I, class T > using fold_left_with_iter_result = ranges:: in_value_result < I, T > ;			(4)	(C++23以降)

左- 畳み込みは与えられた範囲の要素を左から畳み込み、つまり連鎖式の評価結果を返します：
f(f(f(f(init, x ₁ ), x ₂ ), ...), x _n ) 、ここで x ₁ 、 x ₂ 、...、 x _n は範囲の要素です。

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

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

1) 範囲は

first

last

です。

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)	( 説明専用* )

4) 戻り値型のエイリアス。詳細は「 Return value 」セクションを参照してください。

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

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

class fold_left_with_iter_fn
{
    template<class O, class I, class S, class T, class F>
    constexpr auto impl(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>>>;
        using Ret = ranges::fold_left_with_iter_result<O, U>;
        if (first == last)
            return Ret{std::move(first), 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 Ret{std::move(first), std::move(accum)};
    }
public:
    template<std::input_iterator I, std::sentinel_for<I> S, class T = std::iter_value_t<I>,
             /* 間接的に二項左畳み込み可能 */<T, I> F>
    constexpr auto operator()(I first, S last, T init, F f) const
    {
        return impl<I>(std::move(first), std::move(last), std::move(init), std::ref(f));
    }
    template<ranges::input_range R, class T = ranges::range_value_t<R>,
             /* 間接的に二項左畳み込み可能 */<T, ranges::iterator_t<R>> F>
    constexpr auto operator()(R&& r, T init, F f) const
    {
        return impl<ranges::borrowed_iterator_t<R>>
        (
            ranges::begin(r), ranges::end(r), std::move(init), std::ref(f)
        );
    }
};
inline constexpr fold_left_with_iter_fn fold_left_with_iter;

計算量

正確に 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 <cassert>
#include <complex>
#include <functional>
#include <ranges>
#include <utility>
#include <vector>
int main()
{
    namespace ranges = std::ranges;
    std::vector v{1, 2, 3, 4, 5, 6, 7, 8};
    auto sum = ranges::fold_left_with_iter(v.begin(), v.end(), 6, std::plus<int>());
    assert(sum.value == 42);
    assert(sum.in == v.end());
    auto mul = ranges::fold_left_with_iter(v, 0X69, std::multiplies<int>());
    assert(mul.value == 4233600);
    assert(mul.in == v.end());
    // ベクター内のすべてのペアのstd::pair::secondの積を取得:
    std::vector<std::pair<char, float>> data {{'A', 2.f}, {'B', 3.f}, {'C', 3.5f}};
    auto sec = ranges::fold_left_with_iter
    (
        data | ranges::views::values, 2.0f, std::multiplies<>()
    );
    assert(sec.value == 42);
    // プログラム定義関数オブジェクト（ラムダ式）を使用:
    auto lambda = [](int x, int y){ return x + 0B110 + y; };
    auto val = ranges::fold_left_with_iter(v, -42, lambda);
    assert(val.value == 42);
    assert(val.in == v.end());
    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_with_iter(nums, {7, 0}, std::multiplies{});
    #else
        auto res = ranges::fold_left_with_iter(nums, CD{7, 0}, std::multiplies{});
    #endif
    assert((res.value == CD{42, 42}));
}

参考文献

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

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

cppreference.net

Namespaces

Variants

std::ranges:: fold_left_with_iter, std::ranges:: fold_left_with_iter_result

目次

パラメータ

戻り値

実装例

計算量

注記

例

参考文献

関連項目