mkldnn::engine Struct Reference

An execution engine. More...

#include <mkldnn.hpp>

Inheritance diagram for mkldnn::engine:

Collaboration diagram for mkldnn::engine:

Public Types
enum	kind { any = mkldnn_any_engine, cpu = mkldnn_cpu }
	Kinds of engines. More...

Public Member Functions
	engine (kind akind, size_t index)
	Constructs an engine. More...
	engine (const mkldnn_engine_t &aengine)
	engine (const handle< mkldnn_primitive_desc_t > &pd)
Public Member Functions inherited from mkldnn::handle< mkldnn_engine_t >
	handle (const handle &other)
handle &	operator= (const handle &other)
bool	operator== (const handle &other) const
bool	operator!= (const handle &other) const
void	reset (mkldnn_engine_t t, bool weak=false)
	Resets the value of a C handle. More...
mkldnn_engine_t	get () const
	Returns the value of the underlying C handle. More...

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

Friends
class	primitive

Additional Inherited Members
Protected Member Functions inherited from mkldnn::handle< mkldnn_engine_t >
	handle (mkldnn_engine_t t=0, bool weak=false)
	Constructs a C handle wrapper. More...
bool	operator== (const mkldnn_engine_t other) const
bool	operator!= (const mkldnn_engine_t other) const

Detailed Description

An execution engine.

Member Enumeration Documentation

kind

enum mkldnn::engine::kind

Kinds of engines.

Enumerator
any	An unspecified engine.
cpu	CPU engine.

Constructor & Destructor Documentation

engine() [1/3]

mkldnn::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() [2/3]

mkldnn::engine::engine ( const mkldnn_engine_t &  aengine )

inlineexplicit

engine() [3/3]

mkldnn::engine::engine ( const handle< mkldnn_primitive_desc_t > &  pd )

inline

Member Function Documentation

get_count()

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

inlinestatic

Returns the number of engines of a certain kind.

Parameters

akind

The kind of engines to count.

query()

template<class primitive_desc >

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

inlinestatic

Friends And Related Function Documentation

primitive

friend class primitive

friend

---

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

• include/mkldnn.hpp