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

在头文件中定义 `<algorithm>`
调用签名
	(1)
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 );			(自 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 );			(自 C++26 起)
		(2)
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 );				(自 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 );				(自 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) 返回类型别名。有关详细信息，请参阅“返回值”部分。

此页面上描述的类似函数的实体是 niebloids，也就是说

调用它们时，不能指定显式模板参数列表。
它们都不可见于依赖于参数的查找。
当它们中的任何一个通过普通无限定查找作为函数调用运算符左侧的名称找到时，依赖于参数的查找将被抑制。

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

[edit] 参数

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

[edit] 返回值

设 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>.

[edit] 可能的实现

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>,
             /* indirectly-binary-left-foldable */<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>,
             /* indirectly-binary-left-foldable */<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;

[edit] 复杂度

精确地 ranges::distance(first, last) 次应用函数对象 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` 折叠算法
`__cpp_lib_algorithm_default_value_type`	202403L	(C++26)	算法的列表初始化 (1,2)

[edit] 示例

运行这段代码

#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());
 
    // 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}};
    auto sec = ranges::fold_left_with_iter
    (
        data | ranges::views::values, 2.0f, std::multiplies<>()
    );
    assert(sec.value == 42);
 
    // Use a program defined function object (lambda-expression):
    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}));
}

[edit] 参考文献

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

27.6.18 折叠 [alg.fold]

[edit] 另请参阅

ranges::fold_left (C++23)	左折叠一个元素范围 (niebloid)[edit]
ranges::fold_left_first (C++23)	使用第一个元素作为初始值，左折叠一个元素范围 (niebloid)[edit]
ranges::fold_right (C++23)	右折叠一个元素范围 (niebloid)[编辑]
ranges::fold_right_last (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)
执行支持库 (C++26)
技术规范
符号索引
外部库

cppreference.com

命名空间

变体

视图

操作