struct dnnl::engine

Intel® oneAPI Deep Neural Network Developer Guide and Reference

Download PDF

ID 768875

Date 3/31/2023

Version

Public

A newer version of this document is available. Customers should click here to go to the newest version.

Visible to Intel only — GUID: GUID-162AEDB0-47FA-4263-8054-6C0B5FE9BDE9

View Details

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(const handle<T, traits>&);
    handle(handle<T, traits>&&);
    handle(T t, bool weak = false);
    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.

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(const handle<T, traits>&)

Copy constructor.

handle(handle<T, traits>&&)

Move constructor.

handle(T t, bool weak = false)

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.

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Intel® oneAPI Deep Neural Network Developer Guide and Reference

struct dnnl::engine

Overview

Detailed Documentation