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

Функциональные сущности, описанные на этой странице, являются ниблоидами, то есть:

• Нельзя указывать явные списки шаблонов аргументов при их вызове.
• Они не видны для поиска зависимых от аргументов.
• Когда любой из них находится обычным поиском без квалификаторов в качестве имени слева от оператора вызова функции, поиск зависимых от аргументов запрещен.

На практике они могут быть реализованы как объекты-функции или с помощью специальных расширений компилятора.

Параметры

Значение результата

Объект типа U, содержащий результат левостороннего складирования заданного диапазона по f, где 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,
             __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,
             __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 <functional>
#include <iostream>
#include <ranges>
#include <string>
#include <utility>
#include <vector>
 
int main()
{
    std::vector<int> v {1, 2, 3, 4, 5, 6, 7, 8};
 
    int sum = std::ranges::fold_left(v.begin(), v.end(), 0, std::plus<int>()); // (1)
    std::cout << "sum: " << sum << '\n';
 
    int mul = std::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 = std::ranges::fold_left
    (
        data | std::ranges::views::values, 2.0f, std::multiplies<>()
    );
    std::cout << "sec: " << sec << '\n';
 
    // use a program defined function object (lambda-expression):
    std::string str = std::ranges::fold_left
    (
        v, "A", [](std::string s, int x) { return s + ':' + std::to_string(x); }
    );
    std::cout << "str: " << str << '\n';
}

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

Ссылки

• Стандарт C++23 (ISO/IEC 14882:2023):
• 27.6.18 Fold [alg.fold]

См. также