std::generator

 

C++

Compiler-Unterstützung

Freestanding und gehostet

Sprache

Standardbibliothek

Header der Standardbibliothek

Benannte Anforderungen

Feature-Test-Makros (C++20)

Bibliothek für Sprachunterstützung

Konzepte-Bibliothek (C++20)

Diagnostik-Bibliothek

Speicherverwaltungsbibliothek

Metaprogrammierungsbibliothek (C++11)

Allgemeine Dienstprogramme-Bibliothek

Container-Bibliothek

Iterator-Bibliothek

Ranges-Bibliothek (C++20)

Algorithmen-Bibliothek

Bibliothek für Zeichenketten

Textverarbeitungsbibliothek

Numerik-Bibliothek

Datums- und Zeitbibliothek

Ein-/Ausgabe-Bibliothek

Dateisystembibliothek (C++17)

Unterstützung für nebenläufige Programmierung (C++11)

Ausführungssteuerungsbibliothek (C++26)

Technische Spezifikationen

Symbolverzeichnis

Externe Bibliotheken

 

Dienstprogramm-Bibliotheken

Sprachunterstützung Typunterstützung (Basistypen, RTTI) Bibliotheks-Feature-Test-Makros (C++20) Programm-Dienstprogramme Variadische Funktionen initializer_list (C++11) is_constant_evaluated (C++20) is_within_lifetime (C++26) source_location (C++20) Coroutine-Unterstützung (C++20) Vertragsunterstützung (C++26) Drei-Wege-Vergleich 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)

Allgemeine Hilfsmittel Funktionsobjekte Bit-Manipulation (C++20) bitset hash (C++11) Relationale Operatoren (in C++20 veraltet) rel_ops::operator!=rel_ops::operator>    rel_ops::operator<=rel_ops::operator>= Ganzzahl-Vergleichsfunktionen 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 und Typ-Operationen 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) Gemeinsame Vokabulartypen 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 support

Coroutine traits

coroutine_traits (C++20)

Coroutine handle

coroutine_handle (C++20)

No-op coroutines

noop_coroutine_promise (C++20)

noop_coroutine (C++20)

Trivial awaitables

suspend_never (C++20)

suspend_always (C++20)

Range generators

generator (C++23)

 

Bereichsbibliothek

Bereichszugriff begin cbegin   end cend rbegin crbegin   rend crend size ssize   data cdata reserve_hint (C++26)   empty

Range-Konvertierungen std::from_range_t std::from_range (C++23)(C++23)     to (C++23)

Behandlung von hängenden Iteratoren dangling borrowed_iterator_t borrowed_subrange_t

Range-Primitive
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-Konzepte
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)

Ansichten
view_interface	subrange

Range-Fabriken
empty_viewviews::empty	single_viewviews::single	basic_istream_viewviews::istream	iota_viewviews::iota	repeat_viewviews::repeat (C++23)(C++23)

Range-Adaptoren
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 generators std::generator (C++23)

Range-Adaptor-Closure-Objekte range_adaptor_closure (C++23)

Range-Adaptor-Objekte

Hilfselemente
copyable-box movable-box (bis C++23)  (C++23)	simple-view non-propagating-cache

 

std::generator

Memberfunktionen

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)

 

Definiert in Header <generator>
template<     class Ref,     class V = void,     class Allocator = void > class generator     : public ranges::view_interface<generator<Ref, V, Allocator>>	(1)	(seit C++23)
namespace pmr {     template< class Ref, class V = void >     using generator =         std::generator<Ref, V, std::pmr::polymorphic_allocator<>>; }	(2)	(seit C++23)

1) Die Klassenschablone std::generator stellt eine view der Elemente dar, die durch die Auswertung einer Coroutine ergeben werden.

2) Bequeme Alias-Schablone für die generator unter Verwendung des polymorphen Allocators.

Ein std::generator erzeugt eine Sequenz von Elementen, indem die Coroutine, von der er zurückgegeben wurde, wiederholt fortgesetzt wird. Jedes Mal, wenn eine co_yield-Anweisung ausgewertet wird, produziert die Coroutine ein Element der Sequenz. Wenn die co_yield-Anweisung die Form co_yield ranges::elements_of(rng) hat, wird jedes Element des range rng nacheinander als Element der Sequenz produziert.

std::generator modelliert view und input_range.

Das Verhalten eines Programms, das eine Spezialisierung für std::generator hinzufügt, ist undefiniert.

Template-Parameter

Ref	-	der Referenztyp (ranges::range_reference_t) des Generators. Wenn V void ist, werden sowohl der Referenztyp als auch der Werttyp aus Ref abgeleitet.
V	-	der Werttyp (ranges::range_value_t) des Generators oder void
Allocator	-	ein Allocator-Typ oder void

Wenn Allocator nicht void ist, ist das Verhalten undefiniert, wenn Allocator die Allocator-Anforderungen nicht erfüllt.

Member-Typen

Mitglied	Definition
value (private)	std::conditional_t<std::is_void_v<V>, std::remove_cvref_t<Ref>, V>; ((nur zur Veranschaulichung)*)
reference (private)	std::conditional_t<std::is_void_v<V>, Ref&&, Ref>; ((nur zur Veranschaulichung)*)
yielded	std::conditional_t<std::is_reference_v<reference >, reference, const reference &>

Typanforderungen

- std::allocator_traits<Allocator>::pointer ist ein Zeigertyp.

- value ist ein cv-unqualifizierter Objekttyp.

- reference ist entweder ein Referenztyp oder ein cv-unqualifizierter Objekttyp, der copy_constructible modelliert.

- Sei RRef std::remove_reference_t<reference >&&, wenn reference ein Referenztyp ist, und andernfalls reference. std::common_reference_with<reference &&, value &> wird modelliert. std::common_reference_with<reference &&, RRef &&> wird modelliert. std::common_reference_with<RRef &&, const value &> wird modelliert.

Das Programm ist fehlerhaft, wenn eine dieser Typanforderungen nicht erfüllt ist.

Datenmember

Mitglied	Definition
active_ (private)	Intern ist jede aktive Instanz von std::generator mit einem Stack verbunden (behandelt wie durch ein Objekt vom Typ std::unique_ptr<std::stack<std::coroutine_handle<>>>). Wenn begin aufgerufen wird, wird ein neuer Stack erstellt und der Generator zum Stack hinzugefügt. Wenn eine co_yield ranges::elements_of(rng)-Anweisung im Generatorrumpf ausgewertet wird, wird rng in einen Generator konvertiert und zum Stack hinzugefügt, der den umschließenden Generator enthält. Wenn ein Generator-Iterator inkrementiert wird, wird die Coroutine oben auf dem zugehörigen Stack fortgesetzt. Wenn ein Generator beendet wird (d.h. wenn promise_type::final_suspend aufgerufen wird), wird er vom Stack entfernt. ((exposition-only member object*)
coroutine_ (private)	ein Handle vom Typ std::coroutine_handle<promise_type> ((exposition-only member object*)

Member-Funktionen

(Konstruktor)	konstruiert ein generator-Objekt (public member function)
(Destruktor)	zerstört effektiv den gesamten Stack von yield-generierten generators (public member function)
operator=	weist ein generator-Objekt zu (public member function)
begin	setzt die initial suspendierte Coroutine fort und gibt einen Iterator zu ihrem Handle zurück (public member function)
end	gibt std::default_sentinel zurück (public member function)
Geerbt von std::ranges::view_interface
empty	gibt zurück, ob die abgeleitete Ansicht leer ist, bereitgestellt nur, wenn sie sized_range oder forward_range erfüllt (public member function of std::ranges::view_interface<D>)
cbegin (C++23)	gibt einen konstanten Iterator zum Anfang des Bereichs zurück (public member function of std::ranges::view_interface<D>)
cend (C++23)	gibt ein Sentinel für den konstanten Iterator des Bereichs zurück (public member function of std::ranges::view_interface<D>)
operator bool	gibt zurück, ob die abgeleitete Ansicht nicht leer ist, bereitgestellt nur, wenn ranges::empty darauf anwendbar ist (public member function of std::ranges::view_interface<D>)

Verschachtelte Klassen

promise_type	der Promise-Typ (public member class)
iterator	der Iterator-Typ ((nur zur Veranschaulichung)*)

Anmerkungen

Feature-Test-Makro	Wert	Std	Feature
__cpp_lib_generator	202207L	(C++23)	std::generator – synchrone Coroutine-Generator für Ranges

Beispiel

Führen Sie diesen Code aus

#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';
}

Ausgabe

A B C D E F G

Referenzen

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

• 26.8 Range generators [coro.generator]

Siehe auch

noop_coroutine (C++20)

Erzeugt ein Coroutine-Handle, das beim Wiederaufnehmen oder Zerstören keine beobachtbaren Effekte hat (Funktion)