std::ranges::fold_left_first

来自cppreference.com
< cpp‎ | algorithm‎ | ranges
 
 
算法库
受约束算法及范围上的算法 (C++20)
包含算法例如 ranges::copy, ranges::sort, ...
执行策略 (C++17)
排序和相关操作
划分操作
排序操作
二分搜索操作(在已划分范围上)
集合操作(在有序范围上)
归并操作(在有序范围上)
堆操作
最小/最大操作
(C++11)
(C++17)
字典序比较操作
排列操作
C 库

数值运算
(C++11)                       
在未初始化内存上的操作
 
受约束算法
本菜单中的所有名字均属于命名空间 std::ranges
不修改序列的操作
修改序列的操作
划分操作
排序操作
二分搜索操作(在有序范围上)
       
       
集合操作(在有序范围上)
堆操作
最小/最大操作
       
       
排列操作
折叠操作
(C++23)
fold_left_first
(C++23)  
(C++23)
(C++23)  
数值操作
(C++23)            
未初始化存储上的操作
返回类型
 
在标头 <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*/ = /* 见说明 */;
(3) (仅用于阐述*)

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

非正式地说,除了将 *first 用作首个元素之外,ranges::fold_left_first 行为类似 std::accumulate 接受二元谓词的重载。

如果 [firstlast) 不是有效范围则行为未定义。

1) 范围为 [firstlast)。它等价于 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) (仅用于阐述*)

此页面上描述的函数式实体是算法函数对象(非正式地称为 niebloid),即:

目录

[编辑] 参数

first, last - 要折叠的元素范围的迭代器-哨位对
r - 应用折叠的范围
f - 二元函数对象

[编辑] 返回值

容纳了给定范围上执行 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;

[编辑] 复杂度

准确应用 ranges::distance(first, last) - 1(假设范围不为空)次函数对象 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>

其中 BRranges::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>>

其中 BRranges::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
    (
        "获得所有 pair 的 pair::second 的乘积:"
        && *std::ranges::fold_left_first
        (
            pairs | std::ranges::views::values, std::multiplies{}
        ) == 42
    );
}

[编辑] 引用

  • C++23 标准(ISO/IEC 14882:2024):
  • 27.6.18 Fold [alg.fold]

[编辑] 参阅

左折叠范围中元素
(算法函数对象) [编辑]
右折叠范围中元素
(算法函数对象) [编辑]
以末元素为初值右折叠范围中元素
(算法函数对象) [编辑]
左折叠范围中元素,并返回 pair(迭代器,值)
(算法函数对象) [编辑]
以首元素为初值左折叠范围中元素,并返回 pair(迭代器,optional
(算法函数对象) [编辑]
求和或折叠范围中元素
(函数模板) [编辑]
(C++17)
类似 std::accumulate,但不依序执行
(函数模板) [编辑]