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

From cppreference.net

Определено в заголовке `<algorithm>`
Сигнатура вызова
	(1)
template < std:: input_iterator I, std:: sentinel_for < I > S, class T, /* indirectly-binary-left-foldable / < T, I > F > constexpr / см. описание */ fold_left_with_iter ( I first, S last, T init, F f ) ;			(начиная с 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 / см. описание */ fold_left_with_iter ( I first, S last, T init, F f ) ;			(начиная с C++26)
		(2)
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 ) ;				(начиная с 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 ) ;				(начиная с 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) Псевдоним возвращаемого типа. См. раздел " Return value " для подробностей.

Функциональные сущности, описанные на этой странице, являются алгоритмическими функциональными объектами (неформально известными как 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>,
             /* 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 = 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 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 Свёртка [alg.fold]

Смотрите также

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 , но без сохранения порядка (шаблон функции)

Compiler support
Freestanding and hosted
Language
Standard library
Standard library headers
Named requirements
Feature test macros (C++20)
Language support library
Concepts library (C++20)
Diagnostics library
Memory management library
Metaprogramming library (C++11)
General utilities library
Containers library
Iterators library
Ranges library (C++20)
Algorithms library
Strings library
Text processing library
Numerics library
Date and time library
Input/output library
Filesystem library (C++17)
Concurrency support library (C++11)
Execution control library (C++26)
Technical specifications
Symbols index
External libraries

cppreference.net

Namespaces

Variants