std::ranges::fold_left_with_iter, std::ranges::fold_left_with_iter_result
| Определено в заголовке <algorithm>
|
||
| Сигнатура вызова |
||
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 );
|
(1) | (начиная с 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 /* see description */
fold_left_with_iter( I first, S last, T init, F f );
|
(начиная с C++26) | |
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 );
|
(2) | (начиная с 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, x1), x2), ...), xn), где x1, x2, ..., xn — элементы диапазона.
Неформально, ranges::fold_left_with_iter ведёт себя как перегруженный вариант std::accumulate, принимающий бинарный предикат.
Поведение неопределено, если [first, last) не является допустимым диапазоном.
[first, last). r, как если бы ranges::begin(r) использовался как first, а ranges::end(r) как 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>>>;
|
(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) | (только для пояснения*) |
Сущности, подобные функциям, описанные на этой странице, являются объектами-функциями алгоритмов (неформально известными как niebloids), то есть:
- Явные списки аргументов шаблона не могут быть указаны при их вызове.
- Ни один из них не видим при поиске, зависящем от аргументов.
- Когда любой из них находится с помощью обычного неквалифицированного поиска как имя слева от оператора вызова функции, поиск, зависящий от аргументов, подавляется.
Параметры
| first, last | - | пара итератор-страж, определяющая диапазон элементов для свертки |
| r | - | диапазон элементов для свертки |
| init | - | начальное значение свертки |
| f | - | бинарный функциональный объект |
Возвращаемое значение
Пусть 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 = 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]
Смотрите также
|
(C++23)
|
левостороннее свертывание диапазона элементов
(функциональный объект алгоритма) |
|
(C++23)
|
левостороннее свертывание диапазона элементов с использованием первого элемента в качестве начального значения
(функциональный объект алгоритма) |
|
(C++23)
|
правостороннее свертывание диапазона элементов
(функциональный объект алгоритма) |
|
(C++23)
|
правостороннее свертывание диапазона элементов с использованием последнего элемента в качестве начального значения
(функциональный объект алгоритма) |
|
левостороннее свертывание диапазона элементов с использованием первого элемента в качестве начального значения и возвращает
pair
(итератор,
optional
)
(функциональный объект алгоритма) |
|
|
суммирует или сворачивает диапазон элементов
(шаблон функции) |
|
|
(C++17)
|
аналогично
std::accumulate
, но без сохранения порядка
(шаблон функции) |