std::ranges::fold_left_first

template< std::input_iterator I, std::sentinel_for<I> S,
          __indirectly_binary_left_foldable<std::iter_value_t<I>, I> F >
requires std::constructible_from<std::iter_value_t<I>, std::iter_reference_t<I>>
constexpr auto fold_left_first( I first, S last, F f );

template< ranges::input_range R,
          __indirectly_binary_left_foldable<
                ranges::range_value_t<R>, ranges::iterator_t<R>> F >
requires std::constructible_from<
             ranges::range_value_t<R>, ranges::range_reference_t<R>>
constexpr auto fold_left_first( R&& r, F f );

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

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

Неформально, ranges::fold_left_first ведет себя как перегрузка std::accumulate которая принимает бинарный предикат, за исключением того, что *first используется внутри как начальный элемент.

Поведение не определено, если [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>>>>;

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

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

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

Параметры

Возвращаемое значение

Объект типа std::optional<U>, содержащий результат левой свертки заданного диапазона по f, где U эквивалентно decltype(ranges::fold_left(std::move(first), last, std::iter_value_t<I>(*first), f)).

Если диапазон пустой, возвращается std::optional<U>().

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

struct fold_left_first_fn
{
    template<std::input_iterator I, std::sentinel_for<I> S,
             __indirectly_binary_left_foldable<std::iter_value_t<I>, I> F>
    requires
        std::constructible_from<std::iter_value_t<I>, std::iter_reference_t<I>>
    constexpr auto operator()(I first, S last, F f) const
    {
        using U = decltype(
            ranges::fold_left(std::move(first), last, std::iter_value_t<I>(*first), f)
        );
        if (first == last)
            return std::optional<U>();
        std::optional<U> init(std::in_place, *first);
        for (++first; first != last; ++first)
            *init = std::invoke(f, std::move(*init), *first);
        return std::move(init);
    }
 
    template<ranges::input_range R,
             __indirectly_binary_left_foldable<
                 ranges::range_value_t<R>, ranges::iterator_t<R>> F>
    requires
        std::constructible_from<ranges::range_value_t<R>, ranges::range_reference_t<R>>
    constexpr auto operator()(R&& r, F f) const
    {
        return (*this)(ranges::begin(r), ranges::end(r), std::ref(f));
    }
};
 
inline constexpr fold_left_first_fn fold_left_first;

Сложность

Ровно ranges::distance(first, last) - 1 (предполагая, что диапазон не пустой) применений объекта-функции f.

Примечания

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

Пример

#include <algorithm>
#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_first(v.begin(), v.end(), std::plus<int>()); // (1)
    std::cout << "*sum: " << sum.value() << '\n';
 
    auto mul = std::ranges::fold_left_first(v, std::multiplies<int>()); // (2)
    std::cout << "*mul: " << mul.value() << '\n';
 
    // get the product of the std::pair::second of all pairs in the vector:
    std::vector<std::pair<char, float>> data {{'A', 3.f}, {'B', 3.5f}, {'C', 4.f}};
    auto sec = std::ranges::fold_left_first
    (
        data | std::ranges::views::values, std::multiplies<>()
    );
    std::cout << "*sec: " << *sec << '\n';
 
    // use a program defined function object (lambda-expression):
    auto val = std::ranges::fold_left_first(v, [](int x, int y) { return x + y + 13; });
    std::cout << "*val: " << *val << '\n';
}

*sum: 36
*mul: 40320
*sec: 42
*val: 127

Ссылки

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

См. также