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*/ = /* see description */;
|
(3) | (仅用于阐述*) |
左折叠给定范围的元素,即返回链式表达式求值的结果:f(f(f(f(x1, x2), x3), ...), xn),其中 x1、x2、……、xn 是范围的元素。
非正式地说,ranges::fold_left_first 的行为类似于接受二元谓词的 std::accumulate 的重载,区别在于 *first 在内部被用作初始元素。
如果 [first, last) 不是有效范围,则行为未定义。
[first, last)。等价于
return ranges::fold_left_first_with_iter(std::move(first), last, f).value。r 作为范围,如同使用 ranges::begin(r) 作为 first 且 ranges::end(r) 作为 last。| 辅助概念 |
||
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),即:
参数
| first, last | - | 定义待折叠元素 范围 的迭代器-哨位对 |
| r | - | 待折叠的元素范围 |
| 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; |
复杂度
恰好应用函数对象 f 共 ranges:: distance ( first, last ) - 1 次(假设范围非空)。
注释
以下表格对比了所有受约束折叠算法:
| 折叠函数模板 | 起始方向 | 初始值 | 返回类型 |
|---|---|---|---|
| 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 <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 ( "查找唯一(根据前提条件)出现奇数次的数值:" && *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 ( "获取 pairs 中所有 pair::second 的乘积:" && *std::ranges::fold_left_first ( pairs | std::ranges::views::values, std::multiplies{} ) == 42 ); }
参考文献
- C++23 标准 (ISO/IEC 14882:2024):
-
- 27.6.18 折叠算法 [alg.fold]
参见
|
(C++23)
|
对元素范围进行左折叠
(算法函数对象) |
|
(C++23)
|
对元素范围进行右折叠
(算法函数对象) |
|
(C++23)
|
使用最后一个元素作为初始值对元素范围进行右折叠
(算法函数对象) |
|
(C++23)
|
对元素范围进行左折叠,并返回
pair
(迭代器, 值)
(算法函数对象) |
|
使用第一个元素作为初始值对元素范围进行左折叠,并返回
pair
(迭代器,
optional
)
(算法函数对象) |
|
|
对元素范围进行求和或折叠
(函数模板) |
|
|
(C++17)
|
类似于
std::accumulate
,但无序执行
(函数模板) |