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

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

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

template< class F, class T, class I >
concept __indirectly_binary_left_foldable = /* see description */;

template< class I, class T >
using fold_left_with_iter_result = ranges::in_value_result<I, T>;

Выполняет левостороннее сжатие элементов заданного диапазона, то есть возвращает результат вычисления цепочки выражений:
f(f(f(f(init, x1), x2), ...), xn), где x1, x2, ..., xn — элементы диапазона.

Неформально, ranges::fold_left_with_iter ведет себя как перегрузка 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 — std::decay_t<std::invoke_result_t<F&, T, std::iter_reference_t<I>>>.

• Член ranges::in_value_result::in содержит итератор до конца диапазона.
• Член ranges::in_value_result::value содержит результат левостороннего сжатия заданного диапазона над f.

Возможные реализации

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,
             __indirectly_binary_left_foldable<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,
             __indirectly_binary_left_foldable<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.

Примечания

В следующей таблице сравниваются все алгоритмы сжатия с ограничениями:

Пример

#include <algorithm>
#include <cassert>
#include <functional>
#include <iostream>
#include <ranges>
#include <utility>
#include <vector>
 
int main()
{
    std::vector<int> v {1, 2, 3, 4, 5, 6, 7, 8};
 
    auto sum = std::ranges::fold_left_with_iter(v.begin(), v.end(), 6, std::plus<int>());
    std::cout << "sum: " << sum.value << '\n';
    assert(sum.in == v.end());
 
    auto mul = std::ranges::fold_left_with_iter(v, 0X69, std::multiplies<int>());
    std::cout << "mul: " << mul.value << '\n';
    assert(mul.in == v.end());
 
    // 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}};
    auto sec = std::ranges::fold_left_with_iter
    (
        data | std::ranges::views::values, 2.0f, std::multiplies<>()
    );
    std::cout << "sec: " << sec.value << '\n';
 
    // use a program defined function object (lambda-expression):
    auto lambda = [](int x, int y){ return x + 0B110 + y; };
    auto val = std::ranges::fold_left_with_iter(v, -42, lambda);
    std::cout << "val: " << val.value << '\n';
    assert(val.in == v.end());
}

sum: 42
mul: 4233600
sec: 42
val: 42

Ссылки

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

См. также