std::generator

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

ユーティリティライブラリ

言語サポート 型のサポート (基本型、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 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)

自明なawaitable

suspend_never (C++20)

suspend_always (C++20)

Rangeジェネレータ

generator (C++23)

 

Rangesライブラリ

Rangeアクセス begin cbegin   end cend rbegin crbegin   rend crend size ssize   data cdata reserve_hint (C++26)   empty

Range変換 std::from_range_t std::from_range (C++23)(C++23)     to (C++23)

ダングリングイテレータの扱い dangling borrowed_iterator_t borrowed_subrange_t

Rangeプリミティブ
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コンセプト
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

Rangeファクトリ
empty_viewviews::empty	single_viewviews::single	basic_istream_viewviews::istream	iota_viewviews::iota	repeat_viewviews::repeat (C++23)(C++23)

Rangeアダプタ
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)

Rangeジェネレータ std::generator (C++23)

Rangeアダプタクロージャオブジェクト range_adaptor_closure (C++23)

Rangeアダプタオブジェクト

ヘルパーアイテム
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

イテレータ

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 は、コルーチンの評価によって生成 (yield) された要素の view を提供します。

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

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

std::generator は view と input_range をモデル化します。

std::generator の特殊化を追加するプログラムの振る舞いは未定義です。

テンプレートパラメータ

Ref	-	ジェネレータの参照型 (ranges::range_reference_t)。もし V が void ならば、参照型と値型の両方が Ref から推論される
V	-	ジェネレータの値型 (ranges::range_value_t)、または void
アロケータ	-	アロケーター型、または 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 を、もし reference が参照型ならば std::remove_reference_t<reference >&& を、そうでなければ reference を表すものとします。 std::common_reference_with<reference &&, value &> がモデル化されます。 std::common_reference_with<reference &&, RRef &&> がモデル化されます。 std::common_reference_with<RRef &&, const value &> がモデル化されます。

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

データメンバ

メンバ	定義
active_ (private)	内部的には、std::generator の各アクティブなインスタンスは、スタック（std::unique_ptr<std::stack<std::coroutine_handle<>>> 型のオブジェクトによって扱われるかのように）に関連付けられています。 begin が呼び出されると、新しいスタックが作成され、ジェネレータがそのスタックに追加されます。 ジェネレータの本体で co_yield ranges::elements_of(rng) が評価されると、rng はジェネレータに変換され、それを囲むジェネレータを含むスタックに追加されます。 ジェネレータのイテレータがインクリメントされると、関連付けられたスタックの先頭にあるコルーチンが再開されます。 ジェネレータが終了すると（すなわち promise_type::final_suspend が呼ばれると）、それはスタックから削除されます。 (説明用のメンバオブジェクト*)
coroutine_ (private)	std::coroutine_handle<promise_type> 型のハンドル (説明用のメンバオブジェクト*)

メンバ関数

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

ネストされたクラス

promise_type	promise 型 (public メンバクラス)
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 generators [coro.generator]

関連項目

noop_coroutine (C++20)

再開または破棄されても観測可能な効果がないコルーチンハンドルを作成する (関数)