Intel® oneAPI Deep Neural Network Developer Guide and Reference
A newer version of this document is available. Customers should click here to go to the newest version.
struct dnnl::engine
Overview
An execution engine. More…
#include <dnnl_common.hpp> struct engine: public dnnl::handle { // enums enum kind; // construction engine(); engine(kind akind, size_t index); // methods kind get_kind() const; handle(); handle(); handle(); handle(); static size_t get_count(kind akind); };
Inherited Members
public:
// methods
handle<T, traits>& operator = (const handle<T, traits>&);
handle<T, traits>& operator = (handle<T, traits>&&);
void reset(T t, bool weak = false);
T get(bool allow_empty = false) const;
operator T () const;
operator bool () const;
bool operator == (const handle<T, traits>& other) const;
bool operator != (const handle& other) const;
Detailed Documentation
An execution engine.
Construction
engine()
Constructs an empty engine.
An empty engine cannot be used in any operations.
engine(kind akind, size_t index)
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. |
Methods
kind get_kind() const
Returns the kind of the engine.
Returns:
The kind of the engine.
handle()
Constructs an empty handle object.
handle()
Copy constructor.
handle()
Move constructor.
handle()
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. |
static size_t get_count(kind akind)
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.