dnnl::engine Struct Reference

An execution engine. More...

#include <dnnl.hpp>

Inheritance diagram for dnnl::engine:

Collaboration diagram for dnnl::engine:

Public Types
enum	kind
	Kinds of engines. More...

Public Member Functions
	engine ()=default
	Constructs an empty engine. More...
	engine (kind akind, size_t index)
	Constructs an engine. More...
	engine (const handle< dnnl_primitive_desc_t > &pd)
	Constructs an engine based on a primitive from the primitive descriptor pd by querying its engine. More...
kind	get_kind () const
	Returns the kind of the engine. More...
	handle ()=default
	Constructs an empty handle object. More...
	handle (const handle< T, traits > &)=default
	Copy constructor.
	handle (handle< T, traits > &&)=default
	Move constructor.
	handle (T t, bool weak=false)
	Constructs a handle wrapper object from a C API handle. More...
Public Member Functions inherited from dnnl::handle< dnnl_engine_t >
bool	operator== (const handle< dnnl_engine_t, handle_traits< dnnl_engine_t > > &other) const
	Equality operator. More...
bool	operator!= (const handle &other) const
	Inequality operator. More...
	handle ()=default
	Constructs an empty handle object. More...
	handle (const handle< dnnl_engine_t, handle_traits< dnnl_engine_t > > &)=default
	Copy constructor.
	handle (handle< dnnl_engine_t, handle_traits< dnnl_engine_t > > &&)=default
	Move constructor.
	handle (dnnl_engine_t t, bool weak=false)
	Constructs a handle wrapper object from a C API handle. More...
handle< dnnl_engine_t, handle_traits< dnnl_engine_t > > &	operator= (const handle< dnnl_engine_t, handle_traits< dnnl_engine_t > > &)=default
	Assignment operator.
handle< dnnl_engine_t, handle_traits< dnnl_engine_t > > &	operator= (handle< dnnl_engine_t, handle_traits< dnnl_engine_t > > &&)=default
	Move assignment operator.
void	reset (dnnl_engine_t t, bool weak=false)
	Resets the handle wrapper objects to wrap a new C API handle. More...
dnnl_engine_t	get (bool allow_empty=false) const
	Returns the underlying C API handle. More...
	operator dnnl_engine_t () const
	Converts a handle to the underlying C API handle type. More...
	operator bool () const
	Checks whether the object is not empty. More...

Static Public Member Functions
static size_t	get_count (kind akind)
	Returns the number of engines of a certain kind. More...
template<typename primitive_desc >
static engine	query (const primitive_desc &pd)
	Returns the engine of a primitive descriptor. More...

Detailed Description

An execution engine.

Examples:

batch_normalization.cpp, binary.cpp, cnn_inference_f32.cpp, cnn_inference_int8.cpp, cnn_training_bf16.cpp, cnn_training_f32.cpp, concat.cpp, convolution.cpp, cpu_matmul_quantization.cpp, cpu_rnn_inference_f32.cpp, cpu_rnn_inference_int8.cpp, cpu_sgemm_and_matmul.cpp, eltwise.cpp, getting_started.cpp, gpu_opencl_interop.cpp, inference_int8_matmul.cpp, inner_product.cpp, layer_normalization.cpp, logsoftmax.cpp, lrn.cpp, lstm.cpp, matmul.cpp, memory_format_propagation.cpp, performance_profiling.cpp, pooling.cpp, prelu.cpp, reduction.cpp, reorder.cpp, resampling.cpp, rnn_training_f32.cpp, shuffle.cpp, softmax.cpp, sum.cpp, and sycl_interop_buffer.cpp.

Member Enumeration Documentation

kind

enum dnnl::engine::kind

strong

Kinds of engines.

Enumerator
any	An unspecified engine.
cpu	CPU engine.
gpu	GPU engine.

Constructor & Destructor Documentation

engine() [1/3]

dnnl::engine::engine ( )

default

Constructs an empty engine.

An empty engine cannot be used in any operations.

engine() [2/3]

dnnl::engine::engine ( kind  akind, size_t  index  )

inline

Constructs an engine.

Parameters

akind	The kind of engine to construct.
index	The index of the engine. Must be less than the value returned by get_count() for this particular kind of engine.

engine() [3/3]

dnnl::engine::engine ( const handle< dnnl_primitive_desc_t > &  pd )

inline

Constructs an engine based on a primitive from the primitive descriptor pd by querying its engine.

Parameters

pd	The primitive descriptor to query.

Member Function Documentation

get_count()

static size_t dnnl::engine::get_count ( kind  akind )

inlinestatic

Returns the number of engines of a certain kind.

Parameters

akind

The kind of engines to count.

Returns

The number of engines of the specified kind.

get_kind()

kind dnnl::engine::get_kind ( ) const

inline

Returns the kind of the engine.

Returns

The kind of the engine.

query()

template<typename primitive_desc >

static engine dnnl::engine::query ( const primitive_desc &  pd )

inlinestatic

Returns the engine of a primitive descriptor.

Parameters

pd	The primitive descriptor to query.

Returns

A weak handle to the engine that the primitive descriptor was created with.

handle() [1/2]

dnnl::handle< T, traits >::handle

default

Constructs an empty handle object.

Warning

Uninitialized object cannot be used in most library calls and is equivalent to a null pointer. Any attempt to use its methods, or passing it to the other library function, will cause an exception to be thrown.

handle() [2/2]

dnnl::handle< T, traits >::handle

inlineexplicit

Constructs a handle wrapper object from a C API handle.

Parameters

t	The C API handle to wrap.
weak	A flag specifying whether to construct a weak wrapper; defaults to false.

---

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

• include/oneapi/dnnl/dnnl.hpp