std::ranges::fold_right

Определён в заголовочном файле `<algorithm>`
Сигнатура вызова
template< std::bidirectional_iterator I, std::sentinel_for<I> S, class T, /indirectly-binary-right-foldable/<T, I> F > constexpr auto fold_right( I first, S last, T init, F f );	(1)	(начиная с C++23) (до C++26 включительно)
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 fold_right( I first, S last, T init, F f );	(1)		(начиная с C++26)
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 );	(2)	(начиная с 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 );	(2)		(начиная с C++26)

Определение /*indirectly-binary-right-foldable*/ см. на этой странице.

Выполняет свёртку справа элементов исходного диапазона, то есть возвращает результат вычисления цепочечного выражения:
f(x₁, f(x₂, ...f(x_n, init))), где x₁, x₂, ..., x_n — элементы исходного диапазона.

1) Исходный диапазон задаётся [first, last).

2) Исходный диапазон — r.

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

При вызове любой из них нельзя указывать явный список аргументов шаблона.
Ни одна из них не видна для поиска с учётом аргументов.
Если какая-либо из них найдена посредством обычного неквалифицированного поиска как имя слева от оператора вызова функции, поиск с учётом аргументов подавляется.

Параметры

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

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

Результат свёртки справа, равный init, если исходный диапазон пуст.

Примечания

В следующей таблице сравниваются все алгоритмы свёртки с ограничениями. U ниже — тип результата свёртки; это тип результата F после удаления cv-квалификаторов и ссылок.

Функция-шаблон свёртки	Начало свёртки	Начальное значение	Возвращаемый тип
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)

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

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::next(ranges::begin(r), ranges::end(r)),
                       std::move(init), std::ref(f));
    }
};

inline constexpr fold_right_fn fold_right;

Пример

#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';
    
    // Use a program defined function object (lambda-expression):
    std::string r3 = ranges::fold_right
    (
        v, "A", [](int x, std::string s) { return s + ':' + std::to_string(x); }
    );
    std::cout << "r3: " << r3 << '\n';
    
    // 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}};
    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)	выполняет свёртку диапазона элементов слева, используя первый элемент в качестве начального значения, и возвращает пару (итератор, необязательное значение) (функциональный объект алгоритма)
accumulate	суммирует или выполняет свёртку диапазона элементов (функция-шаблон)
reduce (C++17)	похожа на `std::accumulate`, за исключением того, что операции выполняются не по порядку (функция-шаблон)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/algorithm/ranges/fold_right