A class for wrapping an Intel(R) MKL-DNN handle. More...

#include <mkldnn.hpp>

Public Member Functions
	handle (T t, bool weak=false)
	Constructs a C handle wrapper. More...

	handle ()
	Empty constructor. More...

void	reset (T t, bool weak=false)
	Resets the value of a C handle. More...

T	get (bool allow_emtpy=false) const
	Returns the value of the underlying C handle.

Detailed Description

A class for wrapping an Intel(R) MKL-DNN handle.

It is used as the base class for primitive (mkldnn_primitive_t), engine (mkldnn_engine_t), and stream (mkldnn_stream_t) handles. An object of the mkldnn::handle class can be passed by value. This class enables wrapping:

Newly constructed handles.
In this case, the constructed handle uses reference counting provided by std::shared_ptr with a proper deleter function specified through the handle_traits class.
Pre-existing handles returned by the Intel(R) MKL-DNN C API (for example, through mkldnn_primitive_get_primitive_desc()).
In this case, an Intel(R) MKL-DNN C API handle is wrapped without a deleter because it is assumed that the handle wrapper for the original object deletes the handle (this model is similar to std::weak_ptr).

Constructor & Destructor Documentation

template<typename T, typename traits = handle_traits<T>>

mkldnn::handle< T, traits >::handle	(	T	t,
		bool	weak = `false`
	)

inline

Constructs a C handle wrapper.

Parameters

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

template<typename T, typename traits = handle_traits<T>>

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.

template<typename T, typename traits = handle_traits<T>>

void mkldnn::handle< T, traits >::reset	(	T	t,
		bool	weak = `false`
	)

inline

Resets the value of a C handle.

Parameters

t	The new value of the C handle.
weak	A flag to specify whether the wrapper should be weak.

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