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/ = /* 见说明 */;	(3)	(仅用于阐述*)

左折叠给定范围的元素，当 x₁, x₂, ..., x_n 为范围内元素时返回链式表达式 f(f(f(f(x₁, x₂), x₃), ...), x_n) 的求值结果。

非正式地说，除了将 *first 用作首个元素之外，ranges::fold_left_first 行为类似 std::accumulate 接受二元谓词的重载。

如果 [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)	(仅用于阐述*)

此页面上描述的函数式实体是 niebloid，即：

调用它们中的任何一个时不能显式指定模板实参。
它们都不对实参依赖查找可见。
在通过函数调用运算符左侧的名字进行无限定查找，找到它们之一时，禁止实参依赖查找。

实践中，可以作为函数对象，或者用某些特殊编译器扩展实现它们。

参数

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

返回值

容纳了给定范围上执行 f 的左折叠结果的 std::optional<U> 类型对象，其中U 等价于 decltype(ranges::fold_left(std::move(first), last, std::iter_value_t<I>(*first), f))。

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

可能的实现

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;

复杂度

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

注解

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

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

示例

运行此代码

#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';
 
    // 获得 vector 中的所有 pair 的 pair::second 的乘积：
    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';
 
    // 使用程序定义的函数对象（lambda-表达式）：
    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

引用

C++23 标准（ISO/IEC 14882:2024）：

27.6.18 Fold [alg.fold]

参阅

ranges::fold_left (C++23)	左折叠范围内的元素 (niebloid)
ranges::fold_right (C++23)	右折叠范围内的元素 (niebloid)
ranges::fold_right_last (C++23)	使用最后一个元素的值为初始值右折叠范围内的元素 (niebloid)
ranges::fold_left_with_iter (C++23)	左折叠范围内的元素，并且返回一对（迭代器，值） (niebloid)
ranges::fold_left_first_with_iter (C++23)	用第一个元素作为初始值左折叠范围内的元素并返回一对（迭代器，可选值） (niebloid)
accumulate	对一个范围内的元素求和或折叠 (函数模板)
reduce (C++17)	类似 std::accumulate，但不依序执行 (函数模板)

编译器支持
自立实现与有宿主实现
语言
标准库
标准库标头
具名要求
功能特性测试宏 (C++20)
语言支持库
概念库 (C++20)
元编程库 (C++11)
诊断库
通用工具库
字符串库
容器库
迭代器库
范围库 (C++20)
算法库
数值库
本地化库
输入/输出库
文件系统库 (C++17)
正则表达式库 (C++11)
并发支持库 (C++11)
技术规范
符号索引
外部库

std::ranges::fold_left_first

参数

返回值

可能的实现

复杂度

注解

示例

引用

参阅

导航