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

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏(C++20)

语言支持库

概念库(C++20)

诊断库

内存管理库

元编程库(C++11)

通用工具库

容器库

迭代器库

范围库(C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库(C++17)

并发支持库(C++11)

执行控制库(C++26)

技术规范

符号索引

外部库

 

算法库

受约束算法及范围上的算法(C++20)
包含算法例如 ranges::copy, ranges::sort, ...
执行策略 (C++17)
is_execution_policy (C++17)   execution::seqexecution::parexecution::par_unseqexecution::unseq (C++17)    (C++17)(C++17)(C++20)	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policyexecution::parallel_unsequenced (C++17)(C++17)(C++17)(C++20)
不修改序列的操作 批量操作 for_each for_each_n (C++17) 搜索操作 all_ofany_ofnone_of (C++11)                   (C++11)(C++11) countcount_if mismatch equal findfind_iffind_if_not (C++11) find_end find_first_of adjacent_find search search_n 修改序列的操作 复制操作 copycopy_if (C++11) copy_backward copy_n (C++11) move (C++11) move_backward (C++11) 交换操作 swap iter_swap swap_ranges 变换操作 replacereplace_if transform replace_copyreplace_copy_if 生成操作 fill fill_n generate generate_n 移除操作 removeremove_if unique remove_copyremove_copy_if unique_copy 顺序变更操作 reverse reverse_copy rotate rotate_copy random_shuffleshuffle (C++17 前)(C++11) shift_leftshift_right (C++20)(C++20) 采样操作 sample (C++17)	排序和相关操作 划分操作 partition partition_copy (C++11)   stable_partition is_partitioned (C++11) partition_point (C++11) 排序操作 sort stable_sort partial_sort partial_sort_copy is_sorted (C++11) is_sorted_until (C++11) nth_element 二分搜索操作（在已划分范围上） lower_bound upper_bound equal_range binary_search 集合操作（在有序范围上） includes set_union set_intersection set_difference set_symmetric_difference 归并操作（在有序范围上） merge inplace_merge 堆操作 push_heap pop_heap make_heap sort_heap is_heap (C++11) is_heap_until (C++11) 最小/最大操作 max min minmax (C++11) clamp (C++17) max_element min_element minmax_element (C++11) 字典序比较操作 lexicographical_compare lexicographical_compare_three_way (C++20) 排列操作 next_permutation prev_permutation is_permutation (C++11) C 库 qsort bsearch
数值运算
iota (C++11)                        inner_product adjacent_difference accumulate reduce (C++17) transform_reduce (C++17)	partial_sum inclusive_scan (C++17)   exclusive_scan (C++17) transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)
在未初始化内存上的操作
uninitialized_copy uninitialized_move (C++17)    uninitialized_fill uninitialized_copy_n (C++11) uninitialized_move_n (C++17) uninitialized_fill_n	destroy (C++17) destroy_n (C++17) destroy_at (C++17) construct_at (C++20)      uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17)

 

受约束算法

本菜单中的所有名字均属于命名空间 std::ranges

不修改序列的操作

all_ofany_ofnone_of for_each for_each_n    countcount_if adjacent_find mismatch equal lexicographical_compare    containscontains_subrange (C++23)(C++23) findfind_iffind_if_not find_lastfind_last_iffind_last_if_not (C++23)(C++23)(C++23)   find_end find_first_of search search_n starts_with (C++23) ends_with (C++23)

修改序列的操作

copycopy_if copy_n copy_backward    move move_backward shift_leftshift_right (C++23)(C++23)   fill fill_n generate generate_n    transform swap_ranges    shuffle sample removeremove_if replacereplace_if reverse rotate remove_copyremove_copy_if    unique replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy

划分操作

is_partitioned    partition_point    partition    partition_copy    stable_partition

排序操作

is_sorted is_sorted_until     sort stable_sort         partial_sort       nth_element partial_sort_copy

二分搜索操作（在有序范围上）

lower_bound         upper_bound         binary_search      equal_range

集合操作（在有序范围上）

merge inplace_merge       set_difference set_intersection    set_union          includes set_symmetric_difference

堆操作

is_heap is_heap_until       make_heap           sort_heap push_heap pop_heap

最小/最大操作

max max_element         min min_element         minmax minmax_element     clamp

排列操作

is_permutation      next_permutation    prev_permutation

折叠操作

fold_left (C++23) fold_left_first (C++23)   fold_right (C++23) fold_right_last (C++23)   fold_left_with_iter (C++23) fold_left_first_with_iter (C++23)

数值操作 iota (C++23)             随机数生成 generate_random (C++26)

未初始化存储上的操作

construct_at    destroy destroy_n destroy_at uninitialized_copy    uninitialized_move uninitialized_fill uninitialized_copy_n    uninitialized_move_n uninitialized_fill_n uninitialized_default_construct uninitialized_default_construct_n uninitialized_value_construct uninitialized_value_construct_n

返回类型

in_fun_result in_in_result in_found_result    in_out_result in_in_out_result    in_out_out_result    min_max_result out_value_result (C++23) in_value_result (C++23)

 

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

左折叠给定范围的元素，当 x1, x2, ..., xn 为范围内元素时返回链式表达式 f(f(f(f(init, x1), x2), ...), xn) 的求值结果。

非正式的说，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) 除返回值为 ranges::fold_left_with_iter_result<ranges::borrowed_iterator_t<R>, U> 外同 (1)。

可能的实现

class fold_left_with_iter_fn {template<class O, class I, class S, class T, class F>constexprauto 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>constexprauto 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>constexprauto 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));}};   inlineconstexpr fold_left_with_iter_fn fold_left_with_iter;

复杂度

准确应用 ranges::distance(first, last) 次函数对象 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折叠算法
__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());   // 获得 vector 中的所有 pair 的 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_typeauto res = ranges::fold_left_with_iter(nums, {7, 0}, std::multiplies{});#elseauto res = ranges::fold_left_with_iter(nums, CD{7, 0}, std::multiplies{});#endifassert((res.value== CD{42, 42}));}

引用

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

• 27.6.18 Fold [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，但不依序执行 (函数模板)