Spec-Zone.ru › C++

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)
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)
Вспомогательные концепции
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(x1, f(x2, ...f(xn, init))), где x1, x2, ..., xn являются элементами диапазона.

Неформально, ranges::fold_right ведет себя как std::fold_left(ranges::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;    // exposition only
public:
    template< class T, class U >
        requires std::invocable<F&, U, T>
    std::invoke_result_t<F&, U, T> operator()( T&&, U&& );
};
(4B) (только для иллюстрации*)

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

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

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

Параметры

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,
             __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 = invoke(f, *--tail, std::move(accum));
        return accum;
    }
 
    template<ranges::bidirectional_range R, class T,
             __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 алгоритмы свертки

Пример

#include <algorithm>
#include <functional>
#include <iostream>
#include <ranges>
#include <string>
#include <utility>
#include <vector>
using namespace std::literals;
 
int main()
{
    auto v = {1, 2, 3, 4, 5, 6, 7, 8};
    std::vector<std::string> vs {"A", "B", "C", "D"};
 
    auto r1 = std::ranges::fold_right(v.begin(), v.end(), 6, std::plus<>()); // (1)
    std::cout << "r1: " << r1 << '\n';
 
    auto r2 = std::ranges::fold_right(vs, "!"s, std::plus<>()); // (2)
    std::cout << "r2: " << r2 << '\n';
 
    // Use a program defined function object (lambda-expression):
    std::string r3 = std::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 = std::ranges::fold_right
    (
        data | std::ranges::views::values, 2.0f, std::multiplies<>()
    );
    std::cout << "r4: " << r4 << '\n';
}

Вывод:

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

Ссылки

  • Стандарт C++23 (ISO/IEC 14882:2023):
    • 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/w/cpp/algorithm/ranges/fold_right

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API