Single-header, ranges-compatible generator type built on C++20 coroutines

Sy Brand

Last update: Dec 20, 2022

Related tags

Miscellaneous generator

Overview

generator

Single-header, ranges-compatible generator type built with C++20 coroutines.

A generator allows implementing sequence producers which are terse and avoid creating the whole sequence in memory.

For example, if you were to need a sequence of the first n integers, you could generate a std::vector of them. This implementation would be simple, but would have to produce the whole sequence in memory. To avoid this, you could instead write an iterator or range which generates them lazily. However, writing iterators and ranges comes with a lot of boilerplate. Generators have the benefits of both:

tl::generator<int> firstn(std::size_t n) {
   for (auto i = 0; i < n; ++i) {
      co_yield i;
   }
}

You could then use this generator like so:

for (auto i : firstn(10)) {
   std::cout << i;
}

Generators can also create infinite sequences:

tl::generator<int> iota(int i = 0) {
  while(true) {
    co_yield i;
    ++i;
  }
}

You can then pipe this to a range to process it:

for (auto i : iota() | std::views::take(10)) {
   std::cout << i;
}

Compiler support

tl::generator has been tested on Visual Studio 2019 version 16.9 and GCC 10.

To the extent possible under law, Sy Brand has waived all copyright and related or neighboring rights to the optional library. This work is published from: United Kingdom.

A single-header C/C++ library for parsing and evaluation of arithmetic expressions

ceval A C/C++ header for parsing and evaluation of arithmetic expressions. [README file is almost identical to that of the ceval library] Functions ac

9 Oct 10, 2022

A single-header, new syntax for C & C++

sea A new syntax for C & C++, in one header file sea is a new syntax for C & C++. It can be used by adding the following line of code to a .c, or .cc/

1 Nov 19, 2021

base64 single header encode/decode

b64.h base64 single header encode/decode #include stdio.h #include "b64.h" // strings are stored on the heap, don't forget to free() them int main(i

4 Nov 28, 2022

Tuibox - A single-header terminal UI (TUI) library, capable of creating mouse-driven, interactive applications on the command line.

tuibox tuibox ("toybox") is a single-header terminal UI library, capable of creating mouse-driven, interactive applications on the command line. It is

37 Dec 24, 2022

Comments

Allow direct co_yield of a pointer
This PR allows co_yielding a pointer. Now this does not work:

tl::generator<int*> gen() { int i = ...; co_yield &i; //workaround: int* ret = &i; co_yield ret; }
opened by Loghorn 0
add typename before dependent type name

to address the compiling failures from Clang-14, like:

./generator.hpp:76:29: error: missing 'typename' prior to dependent type name 'promise_type::value_type' using value_type = promise_type::value_type; ^~~~~~~~~~~~~~~~~~~~~~~~ typename ./generator.hpp:77:33: error: missing 'typename' prior to dependent type name 'promise_type::reference_type' using reference_type = promise_type::reference_type; ^~~~~~~~~~~~~~~~~~~~~~~~~~~~ typename ./generator.hpp:78:31: error: missing 'typename' prior to dependent type name 'promise_type::pointer_type' using pointer_type = promise_type::pointer_type; ^~~~~~~~~~~~~~~~~~~~~~~~~~ typename

Signed-off-by: Kefu Chai [email protected]

opened by tchaikov 0

Incompatible with Clang 13

I tried to compile with Clang 13 our project with generator...

2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(44,15): error : no type named 'suspend_always' in namespace 'std'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(45,15): error : no type named 'suspend_always' in namespace 'std'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(45,15): error : no type named 'suspend_always' in namespace 'std'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(45,15): error : no type named 'suspend_always' in namespace 'std'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(59,15): error : no type named 'suspend_always' in namespace 'std'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(59,15): error : no type named 'suspend_always' in namespace 'std'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(59,15): error : no type named 'suspend_always' in namespace 'std'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(73,35): error : no template named 'coroutine_handle' in namespace 'std'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(76,29): error : missing 'typename' prior to dependent type name 'promise_type::value_type'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(77,33): error : missing 'typename' prior to dependent type name 'promise_type::reference_type'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(78,31): error : missing 'typename' prior to dependent type name 'promise_type::pointer_type'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(73,35): error : no template named 'coroutine_handle' in namespace 'std'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(76,29): error : missing 'typename' prior to dependent type name 'promise_type::value_type'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(77,33): error : missing 'typename' prior to dependent type name 'promise_type::reference_type'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(78,31): error : missing 'typename' prior to dependent type name 'promise_type::pointer_type'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(73,35): error : no template named 'coroutine_handle' in namespace 'std'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(76,29): error : missing 'typename' prior to dependent type name 'promise_type::value_type'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(77,33): error : missing 'typename' prior to dependent type name 'promise_type::reference_type'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(78,31): error : missing 'typename' prior to dependent type name 'promise_type::pointer_type'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(118,19): error : unknown type name 'handle_type'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(118,19): error : unknown type name 'handle_type'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(118,19): error : unknown type name 'handle_type'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(120,10): error : unknown type name 'handle_type'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(120,10): error : unknown type name 'handle_type'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(120,10): error : unknown type name 'handle_type'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(123,32): error : no template named 'coroutine_handle' in namespace 'std'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(123,32): error : no template named 'coroutine_handle' in namespace 'std'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(123,32): error : no template named 'coroutine_handle' in namespace 'std'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(156,26): error : unknown type name 'handle_type'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(156,26): error : unknown type name 'handle_type'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(156,26): error : unknown type name 'handle_type'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(158,7): error : unknown type name 'handle_type'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(158,7): error : unknown type name 'handle_type'
2>C:\VULKAN\Alter\submodules\include\tl/generator.hpp(158,7): error : unknown type name 'handle_type'

opened by unit-a-user 0

Unable to compile with GCC 11.1

I'm unable to build this with GCC 11.1 because of the following error:

$ cmake --build .
[ 33%] Building CXX object CMakeFiles/tl-generator-catch-main.dir/catch.main.cpp.o
[ 33%] Built target tl-generator-catch-main
[ 66%] Building CXX object CMakeFiles/tl-generator-test-test.dir/tests/test.cpp.o
In file included from /home/wouter/cpp/generator/include/tl/generator.hpp:28,
                 from /home/wouter/cpp/generator/tests/test.cpp:1:
/usr/include/c++/11/ranges: In instantiation of ‘constexpr bool std::ranges::operator==(std::ranges::take_view<tl::generator<int> >::_CI<false>&, const std::ranges::take_view<tl::generator<int> >::_Sentinel<false>&)’:
/home/wouter/cpp/generator/tests/test.cpp:32:51:   required from here
/usr/include/c++/11/ranges:1775:48: error: passing ‘std::ranges::take_view<tl::generator<int> >::_CI<false>’ {aka ‘const std::counted_iterator<tl::generator<int>::iterator>’} as ‘this’ argument discards qualifiers [-fpermissive]
 1775 |           { return __y.count() == 0 || __y.base() == __x._M_end; }
      |                                        ~~~~~~~~^~
In file included from /usr/include/c++/11/iterator:63,
                 from /usr/include/c++/11/ranges:43,
                 from /home/wouter/cpp/generator/include/tl/generator.hpp:28,
                 from /home/wouter/cpp/generator/tests/test.cpp:1:
/usr/include/c++/11/bits/stl_iterator.h:2151:7: note:   in call to ‘constexpr _It std::counted_iterator<_It>::base() && [with _It = tl::generator<int>::iterator]’
 2151 |       base() &&
      |       ^~~~
make[2]: *** [CMakeFiles/tl-generator-test-test.dir/build.make:76: CMakeFiles/tl-generator-test-test.dir/tests/test.cpp.o] Error 1
make[1]: *** [CMakeFiles/Makefile2:130: CMakeFiles/tl-generator-test-test.dir/all] Error 2
make: *** [Makefile:166: all] Error 2

Does this have something to do with constness? I cannot figure it out :-(

opened by wouterbeek 0