std::ranges::fold_left

定义在头文件 `<algorithm>` 中
调用签名
	(1)
template< std::input_iterator I, std::sentinel_for<I> S, class T, /* 间接二元左折叠 */<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>, /* 间接二元左折叠 */<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, /* 间接二元左折叠 */ <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>, /* 间接二元左折叠 */ <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 /* 间接二元左折叠 / = / 见描述 */;			(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，即

调用任何这些实体时，不能指定显式模板参数列表。
它们都不对依赖于参数的查找可见。
当它们中的任何一个在正常无限定查找中被发现为函数调用运算符左侧的名称时，依赖于参数的查找被抑制。

在实践中，它们可以被实现为函数对象，或者使用特殊的编译器扩展。

[编辑] 参数

first, last	-	要折叠的元素范围
r	-	要折叠的元素范围
init	-	折叠的初始值
f	-	二元函数对象

[编辑] 返回值

类型为 U 的对象，其中包含对给定范围的f进行左折叠的结果，其中 U 等效于 std::decay_t<std::invoke_result_t<F&, T, std::iter_reference_t<I>>>.

如果范围为空，则返回 U(std::move(init)).

[编辑] 可能的实现

struct fold_left_fn
{
    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 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>,
             /* indirectly-binary-left-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_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>

特性测试宏	值	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>
 
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';
 
    // 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 sec = ranges::fold_left
    (
        data | ranges::views::values, 2.0f, std::multiplies<>()
    );
    std::cout << "sec: " << sec << '\n';
 
    // use a program defined function object (lambda-expression):
    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)	使用第一个元素作为初始值左折叠元素范围 (niebloid)[编辑]
ranges::fold_right (C++23)	右折叠元素范围 (niebloid)[编辑]
ranges::fold_right_last (C++23)	使用最后一个元素作为初始值右折叠元素范围 (niebloid)[编辑]
ranges::fold_left_with_iter (C++23)	将一系列元素进行左折叠，并返回一个 pair (迭代器，值) (niebloid)[编辑]
ranges::fold_left_first_with_iter (C++23)	使用第一个元素作为初始值，将一系列元素进行左折叠，并返回一个 pair (迭代器，optional) (niebloid)[编辑]
accumulate	将一系列元素进行求和或折叠 (函数模板) [编辑]
reduce (C++17)	类似于 std::accumulate，但顺序不同 (函数模板) [编辑]

编译器支持
独立和托管
语言
标准库
标准库头文件
命名要求
功能测试宏 (C++20)
语言支持库
概念库 (C++20)
元编程库 (C++11)
诊断库
通用实用程序库
字符串库
容器库
迭代器库
范围库 (C++20)
算法库
数值库
本地化库
输入/输出库
文件系统库 (C++17)
正则表达式库 (C++11)
并发支持库 (C++11)
执行支持库 (C++26)
技术规范
符号索引
外部库

cppreference.com

命名空间

变体

视图

操作