std::ranges::fold_left_first_with_iter, std::ranges::fold_left_first_with_iter_result

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (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>
呼叫簽名 (Call signature)
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 /* see description */     fold_left_first_with_iter( 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 /* see description */     fold_left_first_with_iter( R&& r, F f );	(2)	(C++23 起)
輔助概念
template< class F, class T, class I > concept /*indirectly-binary-left-foldable*/ = /* see description */;	(3)	(僅作說明*)
Helper class template
template< class I, class T > using fold_left_first_with_iter_result = ranges::in_value_result<I, T>;	(4)	(C++23 起)

對給定範圍的元素進行左摺疊，即返回鏈式表示式求值的結果
f(f(f(f(x1, x2), x3), ...), xn), 其中 x1, x2, ..., xn 是範圍內的元素。

非正式地，ranges::fold_left_first_with_iter 的行為類似於 std::accumulate 的過載，它接受一個二元謂詞，除了 *first 在內部用作初始元素。

如果 [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），即

• 呼叫它們中的任何一個時，不能指定顯式模板引數列表。
• 它們中的任何一個都對 引數依賴查詢 不可見。
• 當在函式呼叫運算子左側的名稱透過普通非限定查詢找到它們中的任何一個時，依賴於引數的查詢被抑制。

引數

first, last	-	定義要摺疊的元素範圍的迭代器-哨兵對
r	-	要摺疊的元素範圍
f	-	二元函式物件

返回值

設 U 為 decltype(ranges::fold_left(std::move(first), last, std::iter_value_t<I>(*first), f))。

1) 型別為 ranges::fold_left_first_with_iter_result<I, std::optional<U>> 的物件。

• 成員 ranges::in_value_result::in 持有指向範圍末尾的迭代器。
• 成員 ranges::in_value_result::value 持有給定範圍在 f 上的左摺疊結果。

如果範圍為空，則返回值為 {std::move(first), std::optional<U>()}。

2) 同 (1)，但返回型別為 ranges::fold_left_first_with_iter_result<ranges::borrowed_iterator_t<R>, std::optional<U>>。

可能的實現

class fold_left_first_with_iter_fn { template<class O, class I, class S, class F> constexpr auto impl(I&& first, S&& last, F f) const { using U = decltype( ranges::fold_left(std::move(first), last, std::iter_value_t<I>(*first), f) ); using Ret = ranges::fold_left_first_with_iter_result<O, std::optional<U>>; if (first == last) return Ret{std::move(first), 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 Ret{std::move(first), std::move(init)}; }   public: 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 { return impl<I>(std::move(first), std::move(last), std::ref(f)); }   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 impl<ranges::borrowed_iterator_t<R>>( ranges::begin(r), ranges::end(r), std::ref(f) ); } };   inline constexpr fold_left_first_with_iter_fn fold_left_first_with_iter;

複雜度

函式物件 f 的應用次數精確為 ranges::distance(first, last) - 1（假設範圍非空）。

註解

下表比較了所有受限摺疊演算法

摺疊函式模板	開始方向	初始值	返回型別
ranges::fold_left	left	init	U
ranges::fold_left_first	left	第一個元素	std::optional<U>
ranges::fold_right	right	init	U
ranges::fold_right_last	right	最後一個元素	std::optional<U>
ranges::fold_left_with_iter	left	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	left	第一個元素	(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 <cassert>
#include <functional>
#include <iostream>
#include <ranges>
#include <utility>
#include <vector>
 
int main()
{
    std::vector v{1, 2, 3, 4, 5, 6, 7, 8};
 
    auto sum = std::ranges::fold_left_first_with_iter
    (
        v.begin(), v.end(), std::plus<int>()
    );
    std::cout << "sum: " << sum.value.value() << '\n';
    assert(sum.in == v.end());
 
    auto mul = std::ranges::fold_left_first_with_iter(v, std::multiplies<int>());
    std::cout << "mul: " << mul.value.value() << '\n';
    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', 7.f}};
    auto sec = std::ranges::fold_left_first_with_iter
    (
        data | std::ranges::views::values, std::multiplies<>()
    );
    std::cout << "sec: " << sec.value.value() << '\n';
 
    // use a program defined function object (lambda-expression):
    auto lambda = [](int x, int y) { return x + y + 2; };
    auto val = std::ranges::fold_left_first_with_iter(v, lambda);
    std::cout << "val: " << val.value.value() << '\n';
    assert(val.in == v.end());
}

輸出

sum: 36
mul: 40320
sec: 42
val: 50

參考文獻

• 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_with_iter (C++23)	對一個範圍的元素進行左摺疊，並返回一個 pair (迭代器, 值) (演算法函式物件)
accumulate	對一個範圍的元素進行求和或摺疊 (函式模板)
reduce (C++17)	類似於 std::accumulate，但順序是亂序的 (函式模板)