mkldnn::stream Struct Reference

An execution stream. More...

#include <mkldnn.hpp>

Inheritance diagram for mkldnn::stream:

Collaboration diagram for mkldnn::stream:

Public Types
enum	flags : unsigned { flags::default_order = mkldnn_stream_default_order, flags::in_order = mkldnn_stream_default_order, flags::out_of_order = mkldnn_stream_out_of_order, flags::default_flags = mkldnn_stream_default_flags }
	Stream flags. More...

Public Member Functions
	stream (const engine &aengine, flags aflags=flags::default_flags)
	Constructs a stream.
stream &	wait ()
	Waits for all primitives in the stream to finish.
	handle (T t, bool weak=false)
	Constructs a C handle wrapper. More...
	handle ()
	Empty constructor. More...
Public Member Functions inherited from mkldnn::handle< mkldnn_stream_t >
	handle (mkldnn_stream_t t, bool weak=false)
	Constructs a C handle wrapper. More...
	handle ()
	Empty constructor. More...
void	reset (mkldnn_stream_t t, bool weak=false)
	Resets the value of a C handle. More...
mkldnn_stream_t	get (bool allow_emtpy=false) const
	Returns the value of the underlying C handle.

Detailed Description

An execution stream.

Examples:

cpu_cnn_inference_f32.cpp, cpu_cnn_inference_int8.cpp, cpu_cnn_training_bf16.cpp, cpu_cnn_training_f32.cpp, cpu_getting_started.cpp, cpu_memory_format_propagation.cpp, cpu_performance_profiling.cpp, cpu_rnn_inference_f32.cpp, cpu_rnn_inference_int8.cpp, cpu_rnn_training_f32.cpp, gpu_getting_started.cpp, and gpu_opencl_interop.cpp.

Member Enumeration Documentation

flags

enum mkldnn::stream::flags : unsigned

strong

Stream flags.

Enumerator
default_order	Default order execution. Either in-order or out-of-order depending on the engine runtime
in_order	In-order execution.
out_of_order	Out-of-order execution.
default_flags	Default stream configuration.

Member Function Documentation

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

Empty constructor.

Allows declaring an object before actual initialization (mostly for convenience).

Warning

Uninitialized object cannot be used in any library calls. Any attempt to use its methods or passing it to the other library function will lead to a thrown exception.

---

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

• include/mkldnn.hpp