std::ranges::fold_left

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 );

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 );

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 );

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 );

template< class F, class T, class I >
concept /* indirectly-binary-left-foldable */ = /* see description */;

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

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

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

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>>>;

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>>>>;

このページに記載されている関数のようなエンティティはアルゴリズム関数オブジェクトです（非公式にはniebloidsとして知られています）。すなわち:

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

パラメータ

戻り値

指定された範囲を f で左 畳み込み した結果を保持する型 U のオブジェクト。ここで U は std:: decay_t < std:: invoke_result_t < F & , T, std:: iter_reference_t < I >>> と等価です。

範囲が空の場合、 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;

計算量

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

注記

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

例

#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)

参考文献

関連項目