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

ヘッダ `<algorithm>`
呼び出しシグネチャ
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 );	(1)	(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 );	(1)		(C++26 から)
template< ranges::input_range R, class T, /* indirectly-binary-left-foldable / <T, ranges::iterator_t<R>> F > constexpr / see description */ fold_left_with_iter( R&& r, T init, F f );	(2)	(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 / see description */ fold_left_with_iter( R&& r, T init, F f );	(2)		(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) 戻り値型のエイリアス。詳細は「戻り値」のセクションを参照。

このページで説明される関数エンティティはアルゴリズム関数オブジェクト (非形式的にはniebloidsとして知られる) であり、つまり:

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

パラメータ

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

戻り値

U を std:: decay_t < std:: invoke_result_t < F & , T, std:: iter_reference_t < I >>> とする。

1) ranges :: fold_left_with_iter_result < I, U > 型のオブジェクト。

メンバ ranges :: in_value_result :: in は範囲の終端を指すイテレータを保持する。
メンバ ranges :: in_value_result :: value は与えられた範囲の左畳み込みの結果を f に対して保持する。

範囲が空の場合、戻り値は以下の式と同等の方法で取得される： return { std :: move ( first ) , U ( std :: move ( init ) ) } ; 。

2) (1) と同様ですが、戻り値の型は ranges :: fold_left_with_iter_result < ranges:: borrowed_iterator_t < R > , U > です。

実装例

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]

コンパイラサポート
フリースタンディングとホスト環境
言語
標準ライブラリ
標準ライブラリヘッダ
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
概念ライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
レンジライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時刻ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行処理サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
技術仕様書
シンボルインデックス
外部ライブラリ

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 と類似しているが、順序不同 (関数テンプレート)

ja.cppreference.net

Namespaces

Variants

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

目次

パラメータ

戻り値

実装例

計算量

注記

例

参考文献

関連項目