std::ranges::fold_left_first

定义于头文件 `<algorithm>`
调用签名 (Call signature)
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)	(仅作说明*)

对给定范围的元素进行左折叠，即返回链式表达式求值的结果
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），即

调用它们中的任何一个时，不能指定显式模板参数列表。
它们中的任何一个都对参数依赖查找不可见。
当其中任何一个通过 normal unqualified lookup 作为函数调用运算符左侧的名称被找到时，argument-dependent lookup 会被抑制。

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;

[编辑] 复杂度

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

[编辑] 注记

下表比较了所有受限折叠算法

折叠函数模板	开始方向	初始值	返回类型
ranges::fold_left	left	init	U
ranges::fold_left_first	left	第一个元素	std::optional<U>
ranges::fold_right	right	init	U
ranges::fold_right_last	right	最后一个元素	std::optional<U>
ranges::fold_left_with_iter	left	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	left	第一个元素	(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 <array>
#include <functional>
#include <ranges>
#include <utility>
 
int main()
{
    constexpr std::array v{1, 2, 3, 4, 5, 6, 7, 8};
    static_assert
    (
        *std::ranges::fold_left_first(v.begin(), v.end(), std::plus{}) == 36
        && *std::ranges::fold_left_first(v, std::multiplies{}) == 40320
    );
 
    constexpr std::array w
    {
        1, 2, 3, 4, 13,
        1, 2, 3, 4, 13,
        1, 2, 3, 4, 13,
        1, 2, 3, 4,
    };
    static_assert
    (
        "Find the only value that (by precondition) occurs odd number of times:"
        && *std::ranges::fold_left_first(w, [](int p, int q){ return p ^ q; }) == 13
    );
 
    constexpr auto pairs = std::to_array<std::pair<char, float>>
    ({
        {'A', 3.0f},
        {'B', 3.5f},
        {'C', 4.0f}
    });
    static_assert
    (
        "Get the product of all pair::second in pairs:"
        && *std::ranges::fold_left_first
        (
            pairs | std::ranges::views::values, std::multiplies{}
        ) == 42
    );
}

[编辑] 参考

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

27.6.18 折叠 [alg.fold]

[编辑] 参阅

ranges::fold_left (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，但顺序是乱序的 (函数模板) [编辑]

编译器支持
自由（freestanding）与宿主（hosted）
语言
标准库
标准库头文件
具名要求
特性测试宏 (C++20)
语言支持库
概念库 (C++20)
诊断库
内存管理库
元编程库 (C++11)
通用工具库
容器库
迭代器库
范围库 (C++20)
算法库
字符串库
文本处理库
数值库
日期和时间库
输入/输出库
文件系统库 (C++17)
并发支持库 (C++11)
执行控制库 (C++26)
技术规范
符号索引
外部库

first, last	-	定义要折叠的元素范围的迭代器-哨兵对
r	-	要折叠的元素范围
f	-	二元函数对象

cppreference.cn

命名空间

变体

视图

操作

std::ranges::fold_left_first

目录

[编辑] 参数

[编辑] 返回值

[编辑] 可能的实现

[编辑] 复杂度

[编辑] 注记

[编辑] 示例

[编辑] 参考

[编辑] 参阅

导航

工具箱