std::generator

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

工具库

语言支持 类型支持（基本类型、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)

无操作协程

noop_coroutine_promise (C++20)

noop_coroutine (C++20)

平凡可等待对象

suspend_never (C++20)

suspend_always (C++20)

范围生成器 (Range generators)

generator (C++23)

 

范围库 (Ranges library)

范围访问 begin cbegin   end cend rbegin crbegin   rend crend size ssize   data cdata reserve_hint (C++26)   empty

范围转换 (Range conversions) std::from_range_t std::from_range (C++23)(C++23)     to (C++23)

悬空迭代器处理 (Dangling iterator handling) dangling borrowed_iterator_t borrowed_subrange_t

范围原语 (Range primitives)
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 concepts)
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 factories)
empty_viewviews::empty	single_viewviews::single	basic_istream_viewviews::istream	iota_viewviews::iota	repeat_viewviews::repeat (C++23)(C++23)

范围适配器 (Range adaptors)
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 objects) range_adaptor_closure (C++23)

范围适配器对象 (Range adaptor objects)

辅助项 (Helper items)
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

迭代器 (Iterator)

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	-	生成器的值类型（ranges::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 会被转换为生成器并添加到包含 enclosing 生成器的堆栈中。 当生成器迭代器被递增时，相关堆栈顶部的协程会恢复。 当生成器完成时（即当调用 promise_type::final_suspend 时），它会从堆栈中移除。 (仅用于阐释的成员对象*)
coroutine_ (私有)	类型为 std::coroutine_handle<promise_type> 的句柄 (仅用于阐释的成员对象*)

成员函数

(构造函数)	构造 generator 对象 (公有成员函数)
(析构函数)	有效地销毁已生成 generator 的整个堆栈 (公有成员函数)
operator=	赋值一个 generator 对象 (公有成员函数)
begin	恢复最初挂起的协程并返回其句柄的迭代器 (公有成员函数)
end	返回 std::default_sentinel (公有成员函数)
继承自 std::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 – 用于 range 的同步 协程 生成器

示例

运行此代码

#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 生成器 [coro.generator]

另请参阅

noop_coroutine (C++20)

创建一个协程句柄，当恢复或销毁时没有可观察到的效果 (函数)