Skip to main content

GenerationStream Class

Declaration​

class simaai::neat::genai::GenerationStream { ... }

Included Headers​

#include <GenAITypes.h>

Private Member Typedefs Index​

usingProducerFn = std::function< void(Producer &)>
usingCancelFn = std::function< void()>

Friends Index​

classASRModel
classVisionLanguageModel

Public Constructors Index​

GenerationStream (GenerationStream &&) noexcept
GenerationStream (const GenerationStream &)=delete

Private Constructors Index​

GenerationStream (std::unique_ptr< Impl > impl)
GenerationStream (ProducerFn producer, CancelFn cancel)

Public Destructor Index​

~GenerationStream ()

Public Operators Index​

GenerationStream &operator= (GenerationStream &&) noexcept
GenerationStream &operator= (const GenerationStream &)=delete

Public Member Functions Index​

std::optional< TokenSample >next ()
voidcancel ()
iteratorbegin ()
iteratorend ()

Private Member Attributes Index​

std::unique_ptr< Impl >impl_

Definition at line 126 of file GenAITypes.h.

Private Member Typedefs​

CancelFn​

using simaai::neat::genai::GenerationStream::CancelFn = std::function<void()>

Definition at line 190 of file GenAITypes.h.

ProducerFn​

using simaai::neat::genai::GenerationStream::ProducerFn = std::function<void(Producer&)>

Definition at line 189 of file GenAITypes.h.

Friends​

ASRModel​

friend class ASRModel

Definition at line 197 of file GenAITypes.h.

VisionLanguageModel​

friend class VisionLanguageModel

Definition at line 198 of file GenAITypes.h.

Public Constructors​

GenerationStream()​

simaai::neat::genai::GenerationStream::GenerationStream (GenerationStream &&)
 noexcept

Definition at line 160 of file GenAITypes.h.

GenerationStream()​

simaai::neat::genai::GenerationStream::GenerationStream (const GenerationStream &)
 delete

Definition at line 163 of file GenAITypes.h.

Private Constructors​

GenerationStream()​

simaai::neat::genai::GenerationStream::GenerationStream (std::unique_ptr< Impl > impl)
 explicit

Definition at line 192 of file GenAITypes.h.

GenerationStream()​

simaai::neat::genai::GenerationStream::GenerationStream (ProducerFn producer, CancelFn cancel)

Definition at line 193 of file GenAITypes.h.

Public Destructor​

~GenerationStream()​

simaai::neat::genai::GenerationStream::~GenerationStream ()

Definition at line 158 of file GenAITypes.h.

Public Operators​

operator=()​

GenerationStream & simaai::neat::genai::GenerationStream::operator= (GenerationStream &&)
 noexcept

Definition at line 161 of file GenAITypes.h.

operator=()​

GenerationStream & simaai::neat::genai::GenerationStream::operator= (const GenerationStream &)
 delete

Definition at line 164 of file GenAITypes.h.

Public Member Functions​

begin()​

iterator simaai::neat::genai::GenerationStream::begin ()

Definition at line 168 of file GenAITypes.h.

cancel()​

void simaai::neat::genai::GenerationStream::cancel ()

Definition at line 167 of file GenAITypes.h.

end()​

iterator simaai::neat::genai::GenerationStream::end ()

Definition at line 169 of file GenAITypes.h.

next()​

std::optional< TokenSample > simaai::neat::genai::GenerationStream::next ()

Definition at line 166 of file GenAITypes.h.

Private Member Attributes​

impl_​

std::unique_ptr<Impl> simaai::neat::genai::GenerationStream::impl_

Definition at line 195 of file GenAITypes.h.

The documentation for this class was generated from the following file:

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.