generator.h File Reference

Synchronous generator. More...

#include <coroutine>
#include <exception>
#include <iterator>
#include <memory>
#include <ranges>
#include <type_traits>
#include <utility>
#include "detail.h"
#include "exceptions.h"

Include dependency graph for generator.h:

Go to the source code of this file.

Classes
class	wwa::coro::iterator
	An input iterator that produces values of type Result. More...
class	wwa::coro::promise_type
	An synchronous generator that produces values of type Result. More...

Namespaces
namespace	wwa
namespace	wwa::coro
	Library namespace.

Functions
	wwa::coro::~generator ()
	Destructor.
iterator	wwa::coro::begin ()
	Returns an iterator to the current item of the generator.
constexpr iterator	wwa::coro::end () const noexcept
	Returns a sentinel iterator that marks the end of the generator.
	wwa::coro::generator () noexcept=default
	Default constructor.
	wwa::coro::generator (generator &&other) noexcept
	Move constructor.
generator &	wwa::coro::operator= (generator &&other) noexcept
	Move assignment operator.

Detailed Description

Synchronous generator.

This file contains the definition of a synchronous generator class template. The generator template class allows for the creation of coroutine-based generators that produce values of a specified type. It provides an interface for iterating over the generated values using range-based for loops or manual iteration.

Example usage:

wwa::coro::generator<int> fibonacci(int n)
{
    int a = 0;
    int b = 1;
 
    if (n > 0) {
        co_yield a;
    }
 
    if (n > 1) {
        co_yield b;
    }
 
    for (int i = 2; i < n; ++i) {
        auto s = a + b;
        co_yield s;
        a = b;
        b = s;
    }
}

std::cout << "The first 10 Fibonacci numbers are: ";
for (auto n : fibonacci(10)) {
    std::cout << n << ' ';
}

Definition in file generator.h.