Dnnl_api_engine

Collaboration diagram for Dnnl_api_engine:

Classes
struct	dnnl_engine
	An opaque structure to describe an engine. More...

Typedefs
typedef struct dnnl_engine *	dnnl_engine_t
	An engine handle. More...

Enumerations
enum	dnnl_engine_kind_t { dnnl_any_engine, dnnl_cpu, dnnl_gpu }
	Kinds of engines. More...

Functions
size_t DNNL_API	dnnl_engine_get_count (dnnl_engine_kind_t kind)
dnnl_status_t DNNL_API	dnnl_engine_create (dnnl_engine_t *engine, dnnl_engine_kind_t kind, size_t index)
dnnl_status_t DNNL_API	dnnl_engine_get_kind (dnnl_engine_t engine, dnnl_engine_kind_t *kind)
dnnl_status_t DNNL_API	dnnl_engine_destroy (dnnl_engine_t engine)

Detailed Description

Typedef Documentation

dnnl_engine_t

typedef struct dnnl_engine* dnnl_engine_t

An engine handle.

Enumeration Type Documentation

dnnl_engine_kind_t

enum dnnl_engine_kind_t

Kinds of engines.

Enumerator
dnnl_any_engine	An unspecified engine.
dnnl_cpu	CPU engine.
dnnl_gpu	GPU engine.

Function Documentation

dnnl_engine_create()

dnnl_status_t DNNL_API dnnl_engine_create	(	dnnl_engine_t *	engine,
		dnnl_engine_kind_t	kind,
		size_t	index
	)

Creates an engine.

Parameters

engine	Output engine.
kind	Engine kind.
index	Engine index that should be between 0 and the count of engines of the requested kind.

Returns

dnnl_success on success and a status describing the error otherwise.

dnnl_engine_destroy()

dnnl_status_t DNNL_API dnnl_engine_destroy

(

dnnl_engine_t

engine

)

Destroys an engine.

Parameters

engine

Engine to destroy.

Returns

dnnl_success on success and a status describing the error otherwise.

dnnl_engine_get_count()

size_t DNNL_API dnnl_engine_get_count

(

dnnl_engine_kind_t

kind

)

Returns the number of engines of a particular kind.

Parameters

kind	Kind of engines to count.

Returns

Count of the engines.

dnnl_engine_get_kind()

dnnl_status_t DNNL_API dnnl_engine_get_kind	(	dnnl_engine_t	engine,
		dnnl_engine_kind_t *	kind
	)

Returns the kind of an engine.

Parameters

engine	Engine to query.
kind	Output engine kind.

Returns

dnnl_success on success and a status describing the error otherwise.