yakl::Stream Struct Reference

Implements the functionality of a stream for parallel kernel execution. If the Stream::create() method is not called on this object, then it is the default stream. More...

#include <YAKL_streams_events.h>

Public Member Functions
bool	completed ()
	Determine if the task enqueued to the stream has completed. More...
void	create ()
	Create the stream. More...
void	destroy ()
	Destroy the stream. More...
void	fence ()
	Pause all CPU work until all existing work in this stream completes. More...
bool	is_default_stream ()
	Determine whether this stream is the default stream. More...
bool	operator== (Stream stream) const
	Determine if this stream is the same as the passed stream. More...
void	wait_on_event (Event event)
	Tell the stream to wait until the passed event completes before continuing work in the stream. More...

Detailed Description

Implements the functionality of a stream for parallel kernel execution. If the Stream::create() method is not called on this object, then it is the default stream.

Member Function Documentation

completed()

bool yakl::Stream::completed ( )

inline

Determine if the task enqueued to the stream has completed.

create()

void yakl::Stream::create ( )

inline

Create the stream.

destroy()

void yakl::Stream::destroy ( )

inline

Destroy the stream.

fence()

void yakl::Stream::fence ( )

inline

Pause all CPU work until all existing work in this stream completes.

is_default_stream()

bool yakl::Stream::is_default_stream ( )

inline

Determine whether this stream is the default stream.

operator==()

bool yakl::Stream::operator== ( Stream  stream ) const

inline

Determine if this stream is the same as the passed stream.

wait_on_event()

void yakl::Stream::wait_on_event ( Event  event )

inline

Tell the stream to wait until the passed event completes before continuing work in the stream.

---

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

• YAKL/src/YAKL_streams_events.h