std::ranges::fold_left_first

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

从左向右折叠给定范围的元素，即返回表达式链的计算结果
f(f(f(f(x₁, x₂), x₃), ...), x_n)，其中 x₁、x₂、...、x_n 是范围中的元素。

非正式地说，ranges::fold_left_first 的行为类似于接受二元谓词的 std::accumulate 的重载，不同之处在于内部使用 *first 作为初始元素。

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

1) 范围是 [first, last)。等效于 return ranges::fold_left_first_with_iter(std::move(first), last, 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，也就是说

调用它们时无法指定显式模板参数列表。
它们都不对参数相关查找可见。
当它们中的任何一个被正常的非限定查找作为函数调用运算符左侧的名称找到时，参数相关查找将被禁止。

实际上，它们可能被实现为函数对象，或者使用特殊的编译器扩展。

[edit] 参数

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

[edit] 返回值

类型为 std::optional<U> 的对象，其中包含给定范围在 f 上进行左折叠的结果，其中 U 等效于 decltype(ranges::fold_left(std::move(first), last, std::iter_value_t<I>(*first), f)).

如果范围为空，则返回 std::optional<U>()。

[edit] 可能的实现

struct fold_left_first_fn
{
    template<std::input_iterator I, std::sentinel_for<I> S,
             /*indirectly-binary-left-foldable*/<std::iter_value_t<I>, I> F>
    requires
        std::constructible_from<std::iter_value_t<I>, std::iter_reference_t<I>>
    constexpr auto operator()(I first, S last, F f) const
    {
        using U = decltype(
            ranges::fold_left(std::move(first), last, std::iter_value_t<I>(*first), f)
        );
        if (first == last)
            return std::optional<U>();
        std::optional<U> init(std::in_place, *first);
        for (++first; first != last; ++first)
            *init = std::invoke(f, std::move(*init), *first);
        return std::move(init);
    }
 
    template<ranges::input_range R,
             /*indirectly-binary-left-foldable*/<
                 ranges::range_value_t<R>, ranges::iterator_t<R>> F>
    requires
        std::constructible_from<ranges::range_value_t<R>, ranges::range_reference_t<R>>
    constexpr auto operator()(R&& r, F f) const
    {
        return (*this)(ranges::begin(r), ranges::end(r), std::ref(f));
    }
};
 
inline constexpr fold_left_first_fn fold_left_first;

[edit] 复杂度

恰好 ranges::distance(first, last) - 1（假设范围不为空）次应用函数对象 f。

[edit] 备注

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

折叠函数模板	从哪里开始	初始值	返回类型
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` 折叠算法

[edit] 示例

运行此代码

#include <algorithm>
#include <functional>
#include <iostream>
#include <ranges>
#include <utility>
#include <vector>
 
int main()
{
    std::vector v{1, 2, 3, 4, 5, 6, 7, 8};
 
    auto sum = std::ranges::fold_left_first(v.begin(), v.end(), std::plus<int>()); // (1)
    std::cout << "*sum: " << sum.value() << '\n';
 
    auto mul = std::ranges::fold_left_first(v, std::multiplies<int>()); // (2)
    std::cout << "*mul: " << mul.value() << '\n';
 
    // get the product of the std::pair::second of all pairs in the vector:
    std::vector<std::pair<char, float>> data {{'A', 3.f}, {'B', 3.5f}, {'C', 4.f}};
    auto sec = std::ranges::fold_left_first
    (
        data | std::ranges::views::values, std::multiplies<>()
    );
    std::cout << "*sec: " << *sec << '\n';
 
    // use a program defined function object (lambda-expression):
    auto val = std::ranges::fold_left_first(v, [](int x, int y) { return x + y + 13; });
    std::cout << "*val: " << *val << '\n';
}

输出

*sum: 36
*mul: 40320
*sec: 42
*val: 127

[edit] 参考

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

27.6.18 Fold [alg.fold]

[edit] 参见

ranges::fold_left (C++23)	左折叠元素范围 (niebloid)[edit]
ranges::fold_right (C++23)	右折叠元素范围 (niebloid)[edit]
ranges::fold_right_last (C++23)	使用最后一个元素作为初始值，右折叠元素范围 (niebloid)[edit]
ranges::fold_left_with_iter (C++23)	左折叠元素范围，并返回一个对 (迭代器, 值) (niebloid)[edit]
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

命名空间

变体

视图

操作