std::generator

ヘッダ `<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 は、コルーチンの評価によって生成される要素のビューを表現します。

2) generator を多相アロケータで使用するための便利なエイリアステンプレート。

std::generator は、コルーチンから返された後にそのコルーチンを再開することで要素のシーケンスを生成します。 co_yield 文が評価されるたびに、コルーチンはシーケンスの1つの要素を生成します。 co_yield 文が co_yield ranges::elements_of(rng) の形式である場合、範囲 rngの各要素がシーケンスの要素として順次生成されます。

std::generator は 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` (private)	std:: conditional_t < std:: is_void_v < V > , std:: remove_cvref_t < Ref > , V > ; ( 説明専用メンバー型* )
`reference` (private)	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` & > がモデル化されている。

これらの型要件のいずれかが満たされない場合、プログラムは不適格です。

データメンバ

メンバ説明

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>
のハンドル (説明専用メンバオブジェクト*)

メンバー関数

(constructor)	`generator`オブジェクトを構築する (public member function)
(destructor)	生成された`generator`のスタック全体を効果的に破棄する (public member function)
operator=	`generator`オブジェクトを代入する (public member function)
begin	初期状態で中断されたコルーチンを再開し、そのハンドルへのイテレータを返す (public member function)
end	std::default_sentinel を返す (public member function)
以下から継承ranges::view_interface
empty	派生ビューが空かどうかを返します。ただし、それが`sized_range` または `forward_range` を満たす場合に限ります(`std::ranges::view_interface<D>`のパブリックメンバ関数)
cbegin (C++23)	範囲の先頭を指す定数イテレータを返します (`std::ranges::view_interface<D>`のパブリックメンバ関数)
cend (C++23)	範囲の定数イテレータの番兵を返します (`std::ranges::view_interface<D>`のパブリックメンバ関数)
operator bool	派生ビューが空でないかどうかを返します。ただし、ranges::empty がそれに適用可能な場合に限ります (`std::ranges::view_interface<D>`のパブリックメンバ関数)

ネストされたクラス

promise_type	プロミス型 (公開メンバークラス)
iterator	イテレータ型 ( 説明専用メンバークラス* )

注記

機能テストマクロ	値	標準	機能
`__cpp_lib_generator`	`202207L`	(C++23)	`std::generator` – 同期コルーチンジェネレータ for レンジ

例

このコードを実行

#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 generators [coro.generator]

コンパイラサポート
フリースタンディングとホスト環境
言語
標準ライブラリ
標準ライブラリヘッダ
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
Ranges ライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時刻ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行処理サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
技術仕様書
シンボル索引
外部ライブラリ

コルーチントレイト
coroutine_traits (C++20)
コルーチンハンドル
coroutine_handle (C++20)
ノーオペレーションコルーチン
noop_coroutine_promise (C++20)
noop_coroutine (C++20)
自明な待機可能オブジェクト
suspend_never (C++20)
suspend_always (C++20)
範囲ジェネレータ
generator (C++23)

メンバ関数
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
イテレータ
generator::iterator::iterator
generator::iterator::operator=
generator::iterator::operator*
generator::iterator::operator++ generator::iterator::operator++(int)
operator==(generator::iterator, std::default_sentinel_t)

ja.cppreference.net

Namespaces

Variants