std::ranges::fold_right

来自cppreference.com
< cpp‎ | algorithm‎ | ranges
 
 
算法库
受约束算法及范围上的算法 (C++20)
受约束算法: std::ranges::copy, std::ranges::sort, ...
执行策略 (C++17)
不修改序列的操作
(C++11)(C++11)(C++11)
(C++17)
修改序列的操作
Partitioning operations
划分操作
排序操作
(C++11)
二分搜索操作
集合操作(在已排序范围上)
堆操作
(C++11)
最小/最大操作
(C++11)
(C++17)

排列
数值运算
未初始化存储上的操作
(C++17)
(C++17)
(C++17)
C 库
 
受约束算法
不修改序列的操作
修改序列的操作
划分操作
排序操作
二分搜索操作
集合操作(在已排序范围上)
堆操作
最小/最大操作
排列
未初始化存储上的操作
返回类型
 
在标头 <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) (仅用于阐述*)

折叠给定范围的元素,当 x1, x2, ..., xn 为范围内元素时返回链式表达式 f(x1, f(x2, ...f(xn, init))) 的求值结果。

非正式地说,ranges::fold_right 的行为类似 std::fold_left(ranges::reverse(r), init, __flipped(f))

如果 [firstlast) 不是有效范围则行为未定义。

1) 范围 [firstlast)
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) (仅用于阐述*)

此页面上描述的仿函数实体是 niebloid,即:

实际上,它们能以函数对象,或者某些特殊编译器扩展实现。

参数

first, last - 应用折叠的范围
r - 应用折叠的范围
init - 折叠的初值
f - 二元函数对象 (FunctionObject)

返回值

容纳了给定范围上执行 f折叠结果的 U 类型对象,其中 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 left init U
ranges::fold_left_first left 首个元素 std::optional<U>
ranges::fold_right right init U
ranges::fold_right_last right 首个元素 std::optional<U>
ranges::fold_left_with_iter left init

(1) std::in_value_result<I, U>

(2) std::in_value_result<BR, U>,

其中 BRranges::borrowed_iterator_t<R>

ranges::fold_left_first_with_iter left 首个元素

(1) std::in_value_result<I, std::optional<U>>

(2) std::in_value_result<BR, std::optional<U>>

其中 BRranges::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';
 
 
    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';
 
 
    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 Fold [alg.fold]

参阅

使用最后一个元素的值为初始值右折叠范围内的元素
(niebloid)
左折叠范围内的元素
(niebloid)
用第一个元素作为初始值左折叠范围内的元素
(niebloid)
左折叠范围内的元素,并且返回 pair(迭代器,值)
(niebloid)
用第一个元素作为初始值左折叠范围内的元素并返回 pair(迭代器,optional
(niebloid)
对一个范围内的元素求和
(函数模板)
(C++17)
类似 std::accumulate,但不依序执行
(函数模板)