标准库标头 <generator> (C++23)

来自cppreference.com
< cpp‎ | header


 
 
标准库头
通用工具
<any> (C++17)
<bitset>
<bit> (C++20)
<charconv> (C++17)
<expected> (C++23)
<format> (C++20)
<functional>
<optional> (C++17)
<stdbit.h> (C++26)
<tuple> (C++11)
<typeindex> (C++11)
<utility>
<variant> (C++17)
容器
<array> (C++11)
<deque>
<flat_map> (C++23)
<flat_set> (C++23)
<forward_list> (C++11)
<hive> (C++26)
<inplace_vector> (C++26)   
<list>
<map>
<mdspan> (C++23)
<queue>
<set>
<span> (C++20)
<stack>
<unordered_map> (C++11)
<unordered_set> (C++11)
<vector>
迭代器
<iterator>
范围
<generator> (C++23)
<ranges> (C++20)
 

此标头是范围库的一部分。

目录

(C++23)
表示同步协程生成器的 view
(类模板) [编辑]

[编辑] 概要

namespace std {
  // 类模板 generator
  template<class Ref, class V = void, class Allocator = void>
  class generator;
 
  namespace pmr {
    template<class Ref, class V = void>
    using generator = std::generator<Ref, V, polymorphic_allocator<>>;
  }
}

[编辑] 类模板 std::generator

namespace std {
  template<class Ref, class V = void, class Allocator = void>
  class generator : public ranges::view_interface<generator<Ref, V, Allocator>>
  {
  private:
    using /*value*/ =
      conditional_t<is_void_v<V>, remove_cvref_t< Ref >, V>;       // 仅用于阐述
    using /*reference*/ = conditional_t<is_void_v<V>, Ref&&, Ref>; // 仅用于阐述
 
    // 类 generator::iterator
    class /*iterator*/; // 仅用于阐述
 
  public:
    using yielded =
      conditional_t<is_reference_v</*reference*/>, /*reference*/, const /*reference*/&>;
 
    // 类 generator::promise_type
    class promise_type;
 
    generator(const generator&) = delete;
    generator(generator&& other) noexcept;
 
    ~generator();
 
    generator& operator=(generator other) noexcept;
 
    /*iterator*/ begin();
    default_sentinel_t end() const noexcept;
 
  private:
    coroutine_handle<promise_type> /*coroutine_*/ = nullptr; // 仅用于阐述
    unique_ptr<stack<coroutine_handle<>>> /*active_*/;       // 仅用于阐述
  };
}

[编辑] std::generator::promise_type

namespace std {
  template<class Ref, class V, class Allocator>
  class generator<Ref, V, Allocator>::promise_type
  {
  public:
    generator get_return_object() noexcept;
 
    suspend_always initial_suspend() const noexcept { return {}; }
    auto final_suspend() noexcept;
 
    suspend_always yield_value(yielded val) noexcept;
 
    auto yield_value(const remove_reference_t<yielded>& lval)
      requires is_rvalue_reference_v<yielded> &&
               constructible_from<remove_cvref_t<yielded>,
                                  const remove_reference_t<yielded>&>;
 
    template<class R2, class V2, class Alloc2, class Unused>
      requires same_as<typename generator<R2, V2, Alloc2>::yielded, yielded>
    auto yield_value(ranges::elements_of<generator<R2, V2, Alloc2>&&, Unused> g) noexcept;
    template<class R2, class V2, class Alloc2, class Unused>
      requires same_as<typename generator<R2, V2, Alloc2>::yielded, yielded>
    auto yield_value(ranges::elements_of<generator<R2, V2, Alloc2>&, Unused> g) noexcept;
 
    template<ranges::input_range R, class Alloc>
      requires convertible_to<ranges::range_reference_t<R>, yielded>
    auto yield_value(ranges::elements_of<R, Alloc> r);
 
    void await_transform() = delete;
 
    void return_void() const noexcept {}
    void unhandled_exception();
 
    void* operator new(size_t size)
      requires same_as<Allocator, void> || default_initializable<Allocator>;
 
    template<class Alloc, class... Args>
    void* operator new(size_t size, allocator_arg_t, const Alloc& alloc, const Args&...);
 
    template<class This, class Alloc, class... Args>
    void* operator new(size_t size, const This&, allocator_arg_t, const Alloc& alloc,
                       const Args&...);
 
    void operator delete(void* pointer, size_t size) noexcept;
 
  private:
    add_pointer_t<yielded> /*value_*/ = nullptr; // 仅用于阐述
    exception_ptr /*except_*/;                   // 仅用于阐述
  };
}

[编辑] std::generator::iterator

namespace std {
  template<class Ref, class V, class Allocator>
  class generator<Ref, V, Allocator>::/*iterator*/
  {
  public:
    using value_type      = /*value*/;
    using difference_type = ptrdiff_t;
 
    /*iterator*/(/*iterator*/&& other) noexcept;
    /*iterator*/& operator=(/*iterator*/&& other) noexcept;
 
    /*reference*/ operator*() const
      noexcept(is_nothrow_copy_constructible_v</*reference*/>);
    /*iterator*/& operator++();
    void operator++(int);
 
    friend bool operator==(const /*iterator*/& i, default_sentinel_t);
 
  private:
    coroutine_handle<promise_type> /*coroutine_*/; // 仅用于阐述
  };
}

[编辑] 引用

  • C++23 标准(ISO/IEC 14882:2024):
  • 26.8.2 Header <generator> synopsis [generator.syn]
  • 26.8.3 Class template generator [coro.generator.class]
  • 26.8.5 Class generator::promise_type [coro.generator.promise]
  • 26.8.6 Class generator::iterator [coro.generator.iterator]