std::ranges:: fold_left

From cppreference.net

定义于头文件 `<algorithm>`
调用签名
	(1)
template < std:: input_iterator I, std:: sentinel_for < I > S, class T, /* indirectly-binary-left-foldable */ < T, I > F > constexpr auto fold_left ( I first, S last, T init, F f ) ;			(C++23 起) (C++26 前)
template < std:: input_iterator I, std:: sentinel_for < I > S, class T = std:: iter_value_t < I > , /* indirectly-binary-left-foldable */ < T, I > F > constexpr auto fold_left ( I first, S last, T init, F f ) ;			(C++26 起)
		(2)
template < ranges:: input_range R, class T, /* indirectly-binary-left-foldable */ < T, ranges:: iterator_t < R >> F > constexpr auto fold_left ( R && r, T init, F f ) ;				(C++23 起) (C++26 前)
template < ranges:: input_range R, class T = ranges:: range_value_t < R > , /* indirectly-binary-left-foldable */ < T, ranges:: iterator_t < R >> F > constexpr auto fold_left ( R && r, T init, F f ) ;				(C++26 起)
辅助概念
template < class F, class T, class I > concept /* indirectly-binary-left-foldable / = / see description */ ;			(3)	( 仅用于说明* )

对给定范围的元素进行左折叠，即返回链式表达式的求值结果：
f(f(f(f(init, x ₁ ), x ₂ ), ...), x _n ) ，其中 x ₁ 、 x ₂ 、...、 x _n 是范围的元素。

非正式地说， ranges::fold_left 的行为类似于接受二元谓词的 std::accumulate 重载版本。

如果 [ first , last ) 不是有效范围，则行为未定义。

1) 范围是

first

last

。等价于 return ranges:: fold_left_with_iter ( std :: move ( first ) , last, std :: move ( init ) , f ) . value 。

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)	( 仅用于说明* )

本页面描述的函数式实体是 算法函数对象 （非正式称为 niebloids ），即：

在调用其中任何一个函数时，都不能显式指定模板参数列表。
它们对实参依赖查找不可见。
当通过常规非限定查找将其中任何一个函数作为函数调用运算符左侧的名称找到时，会抑制实参依赖查找。

struct fold_left_fn
{
    template<std::input_iterator I, std::sentinel_for<I> S, class T = std::iter_value_t<I>,
             /* 间接可左折叠 */<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&, T, std::iter_reference_t<I>>>;
        if (first == last)
            return U(std::move(init));
        U accum = std::invoke(f, std::move(init), *first);
        for (++first; first != last; ++first)
            accum = std::invoke(f, std::move(accum), *first);
        return std::move(accum);
    }
    template<ranges::input_range R, class T = ranges::range_value_t<R>,
             /* 间接可左折叠 */<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_left_fn fold_left;

复杂度

恰好应用函数对象 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 > , 其中 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>
int main()
{
    namespace ranges = std::ranges;
    std::vector v{1, 2, 3, 4, 5, 6, 7, 8};
    int sum = ranges::fold_left(v.begin(), v.end(), 0, std::plus<int>()); // (1)
    std::cout << "sum: " << sum << '\n';
    int mul = ranges::fold_left(v, 1, std::multiplies<int>()); // (2)
    std::cout << "mul: " << mul << '\n';
    // 获取向量中所有 std::pair 的 second 成员的乘积：
    std::vector<std::pair<char, float>> data {{'A', 2.f}, {'B', 3.f}, {'C', 3.5f}};
    float sec = ranges::fold_left
    (
        data | ranges::views::values, 2.0f, std::multiplies<>()
    );
    std::cout << "sec: " << sec << '\n';
    // 使用程序定义的函数对象（lambda 表达式）：
    std::string str = ranges::fold_left
    (
        v, "A", [](std::string s, int x) { return s + ':' + std::to_string(x); }
    );
    std::cout << "str: " << str << '\n';
    using CD = std::complex<double>;
    std::vector<CD> nums{{1, 1}, {2, 0}, {3, 0}};
    #ifdef __cpp_lib_algorithm_default_value_type
        auto res = ranges::fold_left(nums, {7, 0}, std::multiplies{}); // (2)
    #else
        auto res = ranges::fold_left(nums, CD{7, 0}, std::multiplies{}); // (2)
    #endif
    std::cout << "res: " << res << '\n';
}

输出：

sum: 36
mul: 40320
sec: 42
str: A:1:2:3:4:5:6:7:8
res: (42,42)

参考文献

C++23 标准 (ISO/IEC 14882:2024):

27.6.18 折叠算法 [alg.fold]

参见

ranges::fold_left_first (C++23)	使用首个元素作为初始值对元素范围进行左折叠 (算法函数对象)
ranges::fold_right (C++23)	对元素范围进行右折叠 (算法函数对象)
ranges::fold_right_last (C++23)	使用末尾元素作为初始值对元素范围进行右折叠 (算法函数对象)
ranges::fold_left_with_iter (C++23)	对元素范围进行左折叠，并返回 pair (迭代器, 值) (算法函数对象)
ranges::fold_left_first_with_iter (C++23)	使用首个元素作为初始值对元素范围进行左折叠，并返回 pair (迭代器, 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

first, last	-	定义待折叠元素范围的迭代器-哨位对
r	-	待折叠的元素范围
init	-	折叠操作的初始值
f	-	二元函数对象

cppreference.net

Namespaces

Variants

std::ranges:: fold_left

目录

参数

返回值

可能的实现

复杂度

注释

示例

参考文献

参见