std::ranges::fold_left_with_iter, std::ranges::fold_left_with_iter_result

定义于头文件 `<algorithm>`
调用签名
template< std::input_iterator I, std::sentinel_for<I> S, class T, /* indirectly-binary-left-foldable /<T, I> F > constexpr / see description */ fold_left_with_iter( I first, S last, T init, F f );	(1)	(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 / see description */ fold_left_with_iter( I first, S last, T init, F f );	(1)		(C++26 起)
template< ranges::input_range R, class T, /* indirectly-binary-left-foldable / <T, ranges::iterator_t<R>> F > constexpr / see description */ fold_left_with_iter( R&& r, T init, F f );	(2)	(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 / see description */ fold_left_with_iter( R&& r, T init, F f );	(2)		(C++26 起)
辅助概念
template< class F, class T, class I > concept /* indirectly-binary-left-foldable / = / see description */;	(3)	(仅用于阐述*)
辅助类模板
template< class I, class T > using fold_left_with_iter_result = ranges::in_value_result<I, T>;	(4)	(C++23 起)

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

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

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

1) 范围是 [first, last)。

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

4) 返回类型别名。详情参见“返回值”部分。

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

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

参数

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

返回值

令 U 为 std:: decay_t < std:: invoke_result_t < F & , T, std:: iter_reference_t < I >>> 。

1) 类型为 ranges :: fold_left_with_iter_result < I, U > 的对象。

成员 ranges :: in_value_result :: in 持有指向范围末尾的迭代器。
成员 ranges :: in_value_result :: value 持有给定范围在 f 上的左折叠结果。

若范围为空，则通过等价于 return { std :: move ( first ) , U ( std :: move ( init ) ) } ; 的表达式获得返回值。

2) 与 (1) 相同，但返回类型为 ranges :: fold_left_with_iter_result < ranges:: borrowed_iterator_t < R > , U > 。

可能的实现

class fold_left_with_iter_fn
{
    template<class O, class I, class S, class T, class F>
    constexpr auto impl(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>>>;
        using Ret = ranges::fold_left_with_iter_result<O, U>;
        if (first == last)
            return Ret{std::move(first), 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 Ret{std::move(first), std::move(accum)};
    }
public:
    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
    {
        return impl<I>(std::move(first), std::move(last), std::move(init), std::ref(f));
    }
    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 impl<ranges::borrowed_iterator_t<R>>
        (
            ranges::begin(r), ranges::end(r), std::move(init), std::ref(f)
        );
    }
};
inline constexpr fold_left_with_iter_fn fold_left_with_iter;

复杂度

恰好对函数对象 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 <cassert>
#include <complex>
#include <functional>
#include <ranges>
#include <utility>
#include <vector>
int main()
{
    namespace ranges = std::ranges;
    std::vector v{1, 2, 3, 4, 5, 6, 7, 8};
    auto sum = ranges::fold_left_with_iter(v.begin(), v.end(), 6, std::plus<int>());
    assert(sum.value == 42);
    assert(sum.in == v.end());
    auto mul = ranges::fold_left_with_iter(v, 0X69, std::multiplies<int>());
    assert(mul.value == 4233600);
    assert(mul.in == v.end());
    // 获取向量中所有 std::pair 的 second 成员的乘积：
    std::vector<std::pair<char, float>> data {{'A', 2.f}, {'B', 3.f}, {'C', 3.5f}};
    auto sec = ranges::fold_left_with_iter
    (
        data | ranges::views::values, 2.0f, std::multiplies<>()
    );
    assert(sec.value == 42);
    // 使用程序自定义的函数对象（lambda 表达式）：
    auto lambda = [](int x, int y){ return x + 0B110 + y; };
    auto val = ranges::fold_left_with_iter(v, -42, lambda);
    assert(val.value == 42);
    assert(val.in == v.end());
    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_with_iter(nums, {7, 0}, std::multiplies{});
    #else
        auto res = ranges::fold_left_with_iter(nums, CD{7, 0}, std::multiplies{});
    #endif
    assert((res.value == CD{42, 42}));
}

参考文献

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

27.6.18 折叠算法 [alg.fold]

参见

ranges::fold_left (C++23)	左折叠元素范围 (算法函数对象)
ranges::fold_left_first (C++23)	使用首个元素作为初始值左折叠元素范围 (算法函数对象)
ranges::fold_right (C++23)	右折叠元素范围 (算法函数对象)
ranges::fold_right_last (C++23)	使用末尾元素作为初始值右折叠元素范围 (算法函数对象)
ranges::fold_left_first_with_iter (C++23)	使用首个元素作为初始值左折叠元素范围，并返回 pair (迭代器, optional ) (算法函数对象)
accumulate	对元素范围进行求和或折叠 (函数模板)
reduce (C++17)	类似于 std::accumulate ，但支持乱序执行 (函数模板)

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

zh.cppreference.net

Namespaces

Variants

std::ranges::fold_left_with_iter, std::ranges::fold_left_with_iter_result

目录

参数

返回值

可能的实现

复杂度

注释

示例

参考文献

参见