命名空间
变体
操作

std::ranges::fold_right

来自 cppreference.com
< cpp‎ | algorithm‎ | ranges
 
 
算法库
受约束的算法和范围上的算法 (C++20)
受约束的算法,例如 ranges::copy, ranges::sort, ...
执行策略 (C++17)
排序和相关操作
分区操作
排序操作
二分搜索操作
(在分区范围内)
集合操作(在排序范围内)
合并操作(在排序范围内)
堆操作
最小/最大操作
(C++11)
(C++17)
字典序比较操作
排列操作
C 库
数值操作
未初始化内存上的操作
 
受约束的算法
此菜单中的所有名称都属于命名空间 std::ranges
非修改序列操作
修改序列操作
分区操作
排序操作
二分搜索操作(在排序范围内)
       
       
集合操作(在排序范围内)
堆操作
最小/最大操作
       
       
排列操作
折叠操作
(C++23)
(C++23)  
fold_right
(C++23)
(C++23)  
数值操作
(C++23)            
未初始化存储上的操作
返回类型
 
定义在头文件 <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,

          /* 间接二元右折叠 */
              <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>,

          /* 间接二元右折叠 */
              <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 /* 间接二元左折叠 */ = /* 见描述 */;
(3) (仅供说明*)
template< class F, class T, class I >
concept /* 间接二元右折叠 */ = /* 见描述 */;
(4) (仅供说明*)

向右折叠给定范围的元素,即返回对链表达式求值的计算结果
f(x1, f(x2, ...f(xn, init))),其中 x1x2、...、xn 是范围内的元素。

非正式地,ranges::fold_right 的行为类似于 std::fold_left(ranges::reverse(r), init, /* 翻转 */(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) (仅供说明*)

本页描述的函数式实体为niebloids,即

实际上,这些实体可能被实现为函数对象,或者使用特殊的编译器扩展。

内容

[编辑] 参数

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;

[编辑] 复杂度

函数对象 f 恰好被应用 ranges::distance(first, last) 次。

[编辑] 备注

下表对比了所有受约束的折叠算法

折叠函数模板 从何处开始 初始值 返回类型
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>,

其中 BRranges::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>>

其中 BRranges::borrowed_iterator_t<R>

功能测试 Std 功能
__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';
 
    // 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]

[编辑] 参见

使用最后一个元素作为初始值对元素范围进行右折叠
(niebloid)[编辑]
对元素范围进行左折叠
(niebloid)[编辑]
使用第一个元素作为初始值,将元素范围左折叠
(niebloid)[编辑]
左折叠元素范围,并返回一个 pair (迭代器, 值)
(niebloid)[编辑]
使用第一个元素作为初始值,将元素范围左折叠,并返回一个 pair (迭代器, optional)
(niebloid)[编辑]
对元素范围进行求和或折叠
(函数模板) [编辑]
(C++17)
类似于 std::accumulate,但顺序不同
(函数模板) [编辑]