std::generator

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

技术规范

符号索引

外部库

 

工具库

语言支持 类型支持（基本类型、RTTI） 库功能特性测试宏 (C++20) 动态内存管理 程序工具 协程支持 (C++20) 变参数函数 is_constant_evaluated (C++20) is_within_lifetime (C++26) initializer_list (C++11) source_location (C++20) 调试支持 is_debugger_present (C++26) breakpoint_if_debugging (C++26) breakpoint (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) 初等字符串转换 to_chars (C++17) from_chars (C++17) chars_format (C++17) to_chars_result (C++17) from_chars_result (C++17)

 

协程支持

协程特征

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)

 

范围库

范围访问 begin cbegin   end cend rbegin crbegin   rend crend size ssize   data cdata 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    sized_range	common_range view viewable_range	input_range output_range forward_range	bidirectional_range    random_access_range contiguous_range	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 ref_view owning_view as_rvalue_viewviews::as_rvalue (C++23)(C++23)   filter_viewviews::filter transform_viewviews::transform take_viewviews::take take_while_viewviews::take_while concat_viewviews::concat (C++26)(C++26)	drop_viewviews::drop drop_while_viewviews::drop_while join_viewviews::join join_with_viewviews::join_with (C++23)(C++23)   lazy_split_viewviews::lazy_split split_viewviews::split views::counted common_viewviews::common	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

迭代器

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 表示对协程求值返回的元素的 view。

2) 为使用多态分配器的 generator 提供的便利别名模板。

std::generator 通过反复恢复可返回值的协程以生成元素的序列。 每当 co_yield 语句被求值，协程就产生序列的一个元素。 当 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	-	生成器的值类型（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 是引用类型或者无 cv 限定的实现 copy_constructible 的对象类型。

- 令 /*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> 类型的句柄 (仅用于阐述的成员对象*)

成员函数

(构造函数)	构造一个 generator 对象 (公开成员函数)
(析构函数)	有效率的销毁整个已生成的 generator 栈 (公开成员函数)
operator=	赋值一个 generator 对象 (公开成员函数)
begin	恢复起初暂停的协程并返回指向其句柄的迭代器 (公开成员函数)
end	返回 std::default_sentinel (公开成员函数)
继承自 std::ranges::view_interface
empty	返回视图是否为空。仅当视图满足 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 – 适用于范围的同步协程生成器

示例

运行此代码

#include <generator>
#include <iostream>
 
template<typename T>
struct Tree
{
    T value;
    Tree *left{}, *right{};
 
    std::generator<const T&> traverse_inorder() const
    {
        if (left)
            for (const T& x : left->traverse_inorder())
                co_yield x;
 
        co_yield value;
        if (right)
            for (const T& x : right->traverse_inorder())
                co_yield x;
    }
};
 
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)

创建在等待或销毁时无可观察作用的协程柄 (函数)