mkldnn::stream Struct Reference

#include <mkldnn.hpp>

Inheritance diagram for mkldnn::stream:

Collaboration diagram for mkldnn::stream:

Public Types
enum	kind { any = mkldnn_stream_kind_t::mkldnn_any_stream, eager = mkldnn_stream_kind_t::mkldnn_eager, lazy = mkldnn_stream_kind_t::mkldnn_lazy }

Public Member Functions
	stream (kind akind)
	Constructs a stream. More...
stream &	submit (std::vector< primitive > primitives)
	Submits a vector of primitives to a stream for computations. More...
bool	wait (bool block=true)
	Waits for all computations submitted to the stream to complete. More...
stream &	rerun ()
	handle (T t=0, bool weak=false)
	Constructs a C handle wrapper. More...
	handle (const handle &other)
Public Member Functions inherited from mkldnn::handle< mkldnn_stream_t >
	handle (mkldnn_stream_t t=0, bool weak=false)
	Constructs a C handle wrapper. More...
	handle (const handle &other)
handle &	operator= (const handle &other)
bool	operator== (const handle &other) const
bool	operator!= (const handle &other) const
void	reset (mkldnn_stream_t t, bool weak=false)
	Resets the value of a C handle. More...
mkldnn_stream_t	get () const
	Returns the value of the underlying C handle. More...

Static Public Member Functions
static mkldnn_stream_kind_t	convert_to_c (kind akind)

Additional Inherited Members
Protected Member Functions inherited from mkldnn::handle< mkldnn_stream_t >
bool	operator== (const mkldnn_stream_t other) const
bool	operator!= (const mkldnn_stream_t other) const

Member Enumeration Documentation

kind

enum mkldnn::stream::kind

Enumerator
any
eager
lazy

Constructor & Destructor Documentation

stream()

mkldnn::stream::stream ( kind  akind )

inline

Constructs a stream.

Member Function Documentation

convert_to_c()

static mkldnn_stream_kind_t mkldnn::stream::convert_to_c ( kind  akind )

inlinestatic

submit()

stream& mkldnn::stream::submit ( std::vector< primitive >  primitives )

inline

Submits a vector of primitives to a stream for computations.

Parameters

primitives

The vector of primitives to submit.

Returns

The stream.

wait()

bool mkldnn::stream::wait ( bool  block = true )

inline

Waits for all computations submitted to the stream to complete.

Parameters

block

Specifies whether the operation should wait indefinitely or return immediately.

Returns

true if all computations completed.

false if not all computations completed.

rerun()

stream& mkldnn::stream::rerun ( )

inline

handle() [1/2]

mkldnn::handle< T, traits >::handle

inline

Constructs a C handle wrapper.

Parameters

t	The C handle to wrap.
weak	A flag to specify whether to construct a weak wrapper.

handle() [2/2]

mkldnn::handle< T, traits >::handle

inline

---

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

• include/mkldnn.hpp