std::ranges:: fold_right

From cppreference.net

Определено в заголовке `<algorithm>`
Сигнатура вызова
	(1)
template < std:: bidirectional_iterator I, std:: sentinel_for < I > S, class T, /* косвенно-бинарно-право-сворачиваемый */ < T, I > F > constexpr auto fold_right ( I first, S last, T init, F f ) ;			(начиная с C++23) (до C++26)
template < std:: bidirectional_iterator I, std:: sentinel_for < I > S, class T = std:: iter_value_t < I > , /* косвенно-бинарно-право-сворачиваемый */ < T, I > F > constexpr auto fold_right ( I first, S last, T init, F f ) ;			(начиная с C++26)
		(2)
template < ranges:: bidirectional_range R, class T, /* indirectly-binary-right-foldable */ < T, ranges:: iterator_t < R >> F > constexpr auto fold_right ( R && r, T init, F f ) ;				(начиная с C++23) (до C++26)
template < ranges:: bidirectional_range R, class T = ranges:: range_value_t < R > , /* indirectly-binary-right-foldable */ < T, ranges:: iterator_t < R >> F > constexpr auto fold_right ( 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 F, class T, class I > concept /* indirectly-binary-right-foldable / = / see description */ ;			(4)	( только для демонстрации* )

Правосторонняя свертка элементов заданного диапазона, то есть возвращает результат вычисления цепочки выражений:
f(x ₁ , f(x ₂ , ...f(x _n , init))) , где x ₁ , x ₂ , ..., x _n являются элементами диапазона.

Неформально говоря, ranges::fold_right ведёт себя как ranges:: fold_left ( views:: reverse ( r ) , init, /*flipped*/ ( f ) ) .

Поведение не определено, если [ 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) Эквивалентно:

Вспомогательные концепты
template < class F, class T, class I > concept /indirectly-binary-right-foldable/ = /indirectly-binary-left-foldable/ < /flipped/ < F > , T, I > ;	(4A)	( только для демонстрации* )
Вспомогательные шаблоны классов
template < class F > class /flipped/ { F f ; // только для демонстрации public : template < class T, class U > requires std:: invocable < F & , U, T > std:: invoke_result_t < F & , U, T > operator ( ) ( T && , U && ) ; } ;	(4B)	( только для демонстрации* )

Функциональные сущности, описанные на этой странице, являются algorithm function objects (неформально известными как niebloids ), то есть:

Явные списки аргументов шаблона не могут быть указаны при вызове любого из них.
Ни один из них не видим для argument-dependent lookup .
Когда любой из них найден с помощью normal unqualified lookup как имя слева от оператора вызова функции, argument-dependent lookup блокируется.

Содержание

Параметры

first, last	-	пара итератор-страж, определяющая диапазон элементов для свертки
r	-	диапазон элементов для свертки
init	-	начальное значение свертки
f	-	бинарный функциональный объект

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

Объект типа U , содержащий результат правосторонней свёртки заданного диапазона с помощью f , где U эквивалентен std:: decay_t < std:: invoke_result_t < F & , std:: iter_reference_t < I > , T >> ; .

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

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

struct fold_right_fn
{
    template<std::bidirectional_iterator I, std::sentinel_for<I> S,
             class T = std::iter_value_t<I>,
             /* indirectly-binary-right-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&, std::iter_reference_t<I>, T>>;
        if (first == last)
            return U(std::move(init));
        I tail = ranges::next(first, last);
        U accum = std::invoke(f, *--tail, std::move(init));
        while (first != tail)
            accum = std::invoke(f, *--tail, std::move(accum));
        return accum;
    }
    template<ranges::bidirectional_range R, class T = ranges::range_value_t<R>,
             /* indirectly-binary-right-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_right_fn fold_right;

Сложность

Ровно 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 <complex>
#include <functional>
#include <iostream>
#include <ranges>
#include <string>
#include <utility>
#include <vector>
using namespace std::literals;
namespace ranges = std::ranges;
int main()
{
    auto v = {1, 2, 3, 4, 5, 6, 7, 8};
    std::vector<std::string> vs{"A", "B", "C", "D"};
    auto r1 = ranges::fold_right(v.begin(), v.end(), 6, std::plus<>()); // (1)
    std::cout << "r1: " << r1 << '\n';
    auto r2 = ranges::fold_right(vs, "!"s, std::plus<>()); // (2)
    std::cout << "r2: " << r2 << '\n';
    // Использование программируемого функционального объекта (лямбда-выражения):
    std::string r3 = ranges::fold_right
    (
        v, "A", [](int x, std::string s) { return s + ':' + std::to_string(x); }
    );
    std::cout << "r3: " << r3 << '\n';
    // Получить произведение std::pair::second всех пар в векторе:
    std::vector<std::pair<char, float>> data{{'A', 2.f}, {'B', 3.f}, {'C', 3.5f}};
    float r4 = ranges::fold_right
    (
        data | ranges::views::values, 2.0f, std::multiplies<>()
    );
    std::cout << "r4: " << r4 << '\n';
    using CD = std::complex<double>;
    std::vector<CD> nums{{1, 1}, {2, 0}, {3, 0}};
    #ifdef __cpp_lib_algorithm_default_value_type
        auto r5 = ranges::fold_right(nums, {7, 0}, std::multiplies{});
    #else
        auto r5 = ranges::fold_right(nums, CD{7, 0}, std::multiplies{});
    #endif
    std::cout << "r5: " << r5 << '\n';
}

Вывод:

r1: 42
r2: ABCD!
r3: A:8:7:6:5:4:3:2:1
r4: 42
r5: (42,42)

Ссылки

Стандарт C++23 (ISO/IEC 14882:2024):

27.6.18 Свёртка [alg.fold]

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

ranges::fold_right_last (C++23)	правостороннее свертывание диапазона элементов с использованием последнего элемента в качестве начального значения (объект-функция алгоритма)
ranges::fold_left (C++23)	левостороннее свертывание диапазона элементов (объект-функция алгоритма)
ranges::fold_left_first (C++23)	левостороннее свертывание диапазона элементов с использованием первого элемента в качестве начального значения (объект-функция алгоритма)
ranges::fold_left_with_iter (C++23)	левостороннее свертывание диапазона элементов и возврат пары (итератор, значение) (объект-функция алгоритма)
ranges::fold_left_first_with_iter (C++23)	левостороннее свертывание диапазона элементов с использованием первого элемента в качестве начального значения и возврат пары (итератор, 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