std::generator

 

C++

編譯器支援

獨立式與託管式

語言

標準函式庫

標準函式庫標頭檔

具名要求

特性測試巨集 (C++20)

語言支援函式庫

概念函式庫 (C++20)

診斷函式庫

記憶體管理函式庫

元編程函式庫 (C++11)

通用公用程式函式庫

容器函式庫

疊代器函式庫

Ranges 函式庫 (C++20)

演算法函式庫

字串函式庫

文本處理函式庫

數值函式庫

日期與時間函式庫

輸入/輸出函式庫

檔案系統函式庫 (C++17)

並行支援函式庫 (C++11)

執行控制函式庫 (C++26)

技術規範

符號索引

外部函式庫

 

工具程式庫

語言支援 型別支援 (基本型別, RTTI) 函式庫特性測試巨集 (C++20) 程式公用程式 可變參數函式 initializer_list (C++11) is_constant_evaluated (C++20) is_within_lifetime (C++26) source_location (C++20) 協程支援 (C++20) 合約支援 (C++26) 三向比較 three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20)   is_eqis_ltis_lteq (C++20)(C++20)(C++20)   is_neqis_gtis_gteq (C++20)(C++20)(C++20)

通用公用程式 函式物件 位元操作 (C++20) bitset hash (C++11) 關係運算子 (C++20 中棄用) rel_ops::operator!=rel_ops::operator>    rel_ops::operator<=rel_ops::operator>= 整數比較函式 cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20)   cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) Swap 與 型別操作 swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) 通用詞彙型別 pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23)

 

協程支援

協程特性

coroutine_traits (C++20)

協程句柄

coroutine_handle (C++20)

空操作（No-op）協程

noop_coroutine_promise (C++20)

noop_coroutine (C++20)

平凡可等待物件

suspend_never (C++20)

suspend_always (C++20)

範圍生成器

generator (C++23)

 

Ranges 程式庫

範圍存取 begin cbegin   end cend rbegin crbegin   rend crend size ssize   data cdata reserve_hint (C++26)   empty

範圍轉換 std::from_range_t std::from_range (C++23)(C++23)     to (C++23)

懸空迭代器處理 dangling borrowed_iterator_t borrowed_subrange_t

範圍基本型別
range_size_trange_difference_trange_value_t elements_of (C++23)	iterator_tconst_iterator_tsentinel_tconst_sentinel_t (C++23)(C++23)	range_reference_trange_const_reference_trange_rvalue_reference_trange_common_reference_t (C++23)

範圍概念
range borrowed_range    common_range	sized_range viewable_range    view	input_range output_range forward_range	bidirectional_range    random_access_range contiguous_range	approximately_sized_range (C++26) constant_range (C++23)

檢視
view_interface	subrange

範圍工廠
empty_viewviews::empty	single_viewviews::single	basic_istream_viewviews::istream	iota_viewviews::iota	repeat_viewviews::repeat (C++23)(C++23)

範圍適配器
views::all_tviews::all as_rvalue_viewviews::as_rvalue (C++23)(C++23)   filter_viewviews::filter transform_viewviews::transform take_viewviews::take take_while_viewviews::take_while common_viewviews::common views::counted to_input_viewviews::to_input (C++26)(C++26)	ref_view drop_viewviews::drop drop_while_viewviews::drop_while lazy_split_viewviews::lazy_split split_viewviews::split join_viewviews::join join_with_viewviews::join_with (C++23)(C++23)   concat_viewviews::concat (C++26)(C++26) cache_latest_viewviews::cache_latest (C++26)(C++26)	owning_view reverse_viewviews::reverse as_const_viewviews::as_const (C++23)(C++23) elements_viewviews::elements keys_viewviews::keys values_viewviews::values enumerate_viewviews::enumerate (C++23)(C++23) zip_viewviews::zip (C++23)(C++23) zip_transform_viewviews::zip_transform (C++23)(C++23)	adjacent_viewviews::adjacent (C++23)(C++23) views::pairwise (C++23) adjacent_transform_viewviews::adjacent_transform (C++23)(C++23) views::pairwise_transform (C++23) chunk_viewviews::chunk (C++23)(C++23) slide_viewviews::slide (C++23)(C++23) chunk_by_viewviews::chunk_by (C++23)(C++23) stride_viewviews::stride (C++23)(C++23) cartesian_product_viewviews::cartesian_product (C++23)(C++23)

範圍生成器 std::generator (C++23)

範圍適配器閉包物件 range_adaptor_closure (C++23)

範圍適配器物件

輔助項目
copyable-box movable-box (至 C++23 止)  (自 C++23 起)	simple-view non-propagating-cache

 

std::generator

成員函式

generator::generator

generator::~generator

generator::operator=

generator::begin

generator::end

promise_type

generator::promise_type::get_return_object

generator::promise_type::initial_suspend

generator::promise_type::final_suspend

generator::promise_type::yield_value

generator::promise_type::return_void

generator::promise_type::unhandled_exception

generator::promise_type::operator new

generator::promise_type::operator delete

迭代器 (Iterator)

generator::iterator::iterator

generator::iterator::operator=

generator::iterator::operator*

generator::iterator::operator++ generator::iterator::operator++(int)

operator==(generator::iterator, std::default_sentinel_t)

 

定義於標頭檔 <generator>
template<     class Ref,     class V = void,     class Allocator = void > class generator     : public ranges::view_interface<generator<Ref, V, Allocator>>	(1)	(自 C++23 起)
namespace pmr {     template< class Ref, class V = void >     using generator =         std::generator<Ref, V, std::pmr::polymorphic_allocator<>>; }	(2)	(自 C++23 起)

1) 類別模板 std::generator 展示了一個由協程 (coroutine) 求值所產出元素的 view。

2) 使用多型配置器 (polymorphic allocator) 的 generator 之方便別名模板。

std::generator 透過反覆恢復其所回傳的協程來產生元素序列。每次求值 co_yield 陳述式時，協程就會產出序列中的一個元素。當 co_yield 陳述式形式為 co_yield ranges::elements_of(rng) 時，range rng 的每個元素會被依序產出作為序列的一個元素。

std::generator 實現了 (models) view 與 input_range。

若程式為 std::generator 增加特化，其行為是未定義的。

模板參數

Ref	-	生成器的參照型別 (ranges::range_reference_t)。若 V 為 void，則參照型別與值型別皆由 Ref 推導而來
V	-	生成器的值型別 (ranges::range_value_t)，或為 void
配置器 (Allocator)	-	配置器型別或 void

若 Allocator 不為 void，且 Allocator 未滿足 Allocator 需求，則行為未定義。

成員型別

成員	定義
value (私有)	std::conditional_t<std::is_void_v<V>, std::remove_cvref_t<Ref>, V>; (僅供展示的成員型別*)
reference (私有)	std::conditional_t<std::is_void_v<V>, Ref&&, Ref>; (僅供展示的成員型別*)
yielded	std::conditional_t<std::is_reference_v<reference >, reference, const reference &>

類型要求

- std::allocator_traits<Allocator>::pointer 為一個指標型別。

- value 為一個 cv 限定詞不修飾的物件型別。

- reference 為參照型別，或是滿足 copy_constructible 的 cv 限定詞不修飾的物件型別。

- 令 RRef 表示 std::remove_reference_t<reference >&&（若 reference 為參照型別），否則為 reference 本身。 std::common_reference_with<reference &&, value &> 必須被實現。 std::common_reference_with<reference &&, RRef &&> 必須被實現。 std::common_reference_with<RRef &&, const value &> 必須被實現。

若不滿足上述任一型別需求，則程式語法不合法 (ill-formed)。

資料成員

成員	定義
active_ (私有)	在內部，每個 std::generator 的活躍實例都會關聯一個堆疊（處理方式如同 std::unique_ptr<std::stack<std::coroutine_handle<>>> 型別的物件）。 當呼叫 begin 時，會建立一個新的堆疊並將生成器加入該堆疊中。 當在生成器主體中求值 co_yield ranges::elements_of(rng) 時，rng 會被轉換為生成器，並被加入包含封裝生成器的堆疊中。 當生成器迭代器被遞增時，關聯堆疊頂部的協程將被恢復。 當生成器完成時（即當呼叫 promise_type::final_suspend 時），它會從堆疊中移除。 (僅用於闡述的成員物件*)
coroutine_ (私有)	一個 std::coroutine_handle<promise_type> 型別的控制代碼 (僅用於闡述的成員物件*)

成員函式

(建構子)	建構一個 generator 物件 (公開成員函式)
(解構函式)	有效地銷毀整個已產出 generator 的堆疊 (公開成員函式)
operator=	指派一個 generator 物件 (公開成員函式)
begin	恢復最初暫停的協程，並回傳一個指向其控制代碼的迭代器 (公開成員函式)
end	回傳 std::default_sentinel (公開成員函式)
繼承自 std::ranges::view_interface
empty	回傳派生視圖是否為空，僅在滿足 sized_range 或 forward_range 時提供 (std::ranges::view_interface<D> 的公開成員函式)
cbegin (C++23)	回傳指向範圍起始處的常數迭代器 (std::ranges::view_interface<D> 的公開成員函式)
cend (C++23)	回傳該範圍常數迭代器的哨兵 (sentinel) (std::ranges::view_interface<D> 的公開成員函式)
operator bool	回傳派生視圖是否非空，僅在 ranges::empty 適用於它時提供 (std::ranges::view_interface<D> 的公開成員函式)

巢狀類別

promise_type	promise 型別 (公開成員類別)
iterator	迭代器型別 (僅供展示的成員類別*)

附註

功能測試巨集	數值	標準	功能
__cpp_lib_generator	202207L	(C++23)	std::generator – 用於 ranges 的同步 協程生成器

範例

執行此程式碼

#include <generator>
#include <iostream>
 
template<typename T>
struct Tree
{
    T value;
    Tree *left{}, *right{};
 
    std::generator<const T&> traverse_inorder() const
    {
        if (left)
            co_yield std::ranges::elements_of(left->traverse_inorder());
 
        co_yield value;
 
        if (right)
            co_yield std::ranges::elements_of(right->traverse_inorder());
    }
};
 
int main()
{
    Tree<char> tree[]
    {
                                    {'D', tree + 1, tree + 2},
        //                            │
        //            ┌───────────────┴────────────────┐
        //            │                                │
                    {'B', tree + 3, tree + 4},       {'F', tree + 5, tree + 6},
        //            │                                │
        //  ┌─────────┴─────────────┐      ┌───────────┴─────────────┐
        //  │                       │      │                         │
          {'A'},                  {'C'}, {'E'},                    {'G'}
    };
 
    for (char x : tree->traverse_inorder())
        std::cout << x << ' ';
    std::cout << '\n';
}

輸出

A B C D E F G

參考資料

• C++23 標準 (ISO/IEC 14882:2024)

• 26.8 Range 生成器 [coro.generator]

參見

noop_coroutine (C++20)

建立一個在恢復或銷毀時無可觀測副作用的協程句柄 (函式)