Base class for all primitive descriptors. More...
#include <dnnl.hpp>


Public Member Functions | |
| primitive_desc_base ()=default | |
| Default constructor. Produces an empty object. | |
| engine | get_engine () const |
| Returns the engine of the primitive descriptor. More... | |
| const char * | impl_info_str () const |
| Returns implementation name. More... | |
| memory::dim | query_s64 (query what) const |
| Returns a memory::dim value (same as int64_t). More... | |
| memory::desc | query_md (query what, int idx=0) const |
| Returns a memory descriptor. More... | |
| memory::desc | src_desc (int idx) const |
| Returns a source memory descriptor. More... | |
| memory::desc | dst_desc (int idx) const |
| Returns a destination memory descriptor. More... | |
| memory::desc | weights_desc (int idx) const |
| Returns a weights memory descriptor. More... | |
| memory::desc | diff_src_desc (int idx) const |
| Returns a diff source memory descriptor. More... | |
| memory::desc | diff_dst_desc (int idx) const |
| Returns a diff destination memory descriptor. More... | |
| memory::desc | diff_weights_desc (int idx) const |
| Returns a diff weights memory descriptor. More... | |
| memory::desc | src_desc () const |
| Returns a source memory descriptor. More... | |
| memory::desc | dst_desc () const |
| Returns a destination memory descriptor. More... | |
| memory::desc | weights_desc () const |
| Returns a weights memory descriptor. More... | |
| memory::desc | diff_src_desc () const |
| Returns a diff source memory descriptor. More... | |
| memory::desc | diff_dst_desc () const |
| Returns a diff destination memory descriptor. More... | |
| memory::desc | diff_weights_desc () const |
| Returns a diff weights memory descriptor. More... | |
| memory::desc | workspace_desc () const |
| Returns the workspace memory descriptor. More... | |
| memory::desc | scratchpad_desc () const |
| Returns the scratchpad memory descriptor. More... | |
| engine | scratchpad_engine () const |
| Returns the engine on which the scratchpad memory is located. More... | |
| primitive_attr | get_primitive_attr () const |
| Returns the primitive attributes. More... | |
| dnnl::primitive::kind | get_kind () const |
| Returns the kind of the primitive descriptor. More... | |
Public Member Functions inherited from dnnl::handle< dnnl_primitive_desc_t > | |
| bool | operator== (const handle< dnnl_primitive_desc_t, handle_traits< dnnl_primitive_desc_t > > &other) const |
| Equality operator. More... | |
| bool | operator!= (const handle &other) const |
| Inequality operator. More... | |
| handle ()=default | |
| Constructs an empty handle object. More... | |
| handle (const handle< dnnl_primitive_desc_t, handle_traits< dnnl_primitive_desc_t > > &)=default | |
| Copy constructor. | |
| handle (handle< dnnl_primitive_desc_t, handle_traits< dnnl_primitive_desc_t > > &&)=default | |
| Move constructor. | |
| handle (dnnl_primitive_desc_t t, bool weak=false) | |
| Constructs a handle wrapper object from a C API handle. More... | |
| handle< dnnl_primitive_desc_t, handle_traits< dnnl_primitive_desc_t > > & | operator= (const handle< dnnl_primitive_desc_t, handle_traits< dnnl_primitive_desc_t > > &)=default |
| Assignment operator. | |
| handle< dnnl_primitive_desc_t, handle_traits< dnnl_primitive_desc_t > > & | operator= (handle< dnnl_primitive_desc_t, handle_traits< dnnl_primitive_desc_t > > &&)=default |
| Move assignment operator. | |
| void | reset (dnnl_primitive_desc_t t, bool weak=false) |
| Resets the handle wrapper objects to wrap a new C API handle. More... | |
| dnnl_primitive_desc_t | get (bool allow_empty=false) const |
| Returns the underlying C API handle. More... | |
| operator dnnl_primitive_desc_t () const | |
| Converts a handle to the underlying C API handle type. More... | |
| operator bool () const | |
| Checks whether the object is not empty. More... | |
Protected Member Functions | |
| void | reset_with_clone (const_dnnl_primitive_desc_t pd) |
| Resets the value of the handle to a clone of a C API primitive descriptor. More... | |
| primitive_desc_base (dnnl_primitive_desc_t pd, dnnl::primitive::kind prim_kind) | |
| Constructs a primitive descriptor base object from a clone of a C API primitive descriptor after verifying that it is what the caller expects. More... | |
| primitive_desc_base (dnnl_primitive_desc_t pd, dnnl::primitive::kind prim_kind, dnnl::prop_kind aprop_kind) | |
| Constructs a primitive descriptor base object from a clone of a C API primitive descriptor after verifying that it is what the caller expects. More... | |
| primitive_desc_base (dnnl_primitive_desc_t pd, dnnl::primitive::kind prim_kind, dnnl::prop_kind prop_kind1, dnnl::prop_kind prop_kind2) | |
| Constructs a primitive descriptor base object from a clone of a C API primitive descriptor after verifying that it is what the caller expects. More... | |
Base class for all primitive descriptors.
|
inlineprotected |
Constructs a primitive descriptor base object from a clone of a C API primitive descriptor after verifying that it is what the caller expects.
prim_kind should map to a primitive that does not have different values of propagation kind (e.g. dnnl::binary). | pd | C API primitive descriptor to clone. |
| prim_kind | Expected primitive kind. |
|
inlineprotected |
Constructs a primitive descriptor base object from a clone of a C API primitive descriptor after verifying that it is what the caller expects.
| pd | C API primitive descriptor to clone. |
| prim_kind | Expected primitive kind. |
| aprop_kind | Expected propagation kind. |
|
inlineprotected |
Constructs a primitive descriptor base object from a clone of a C API primitive descriptor after verifying that it is what the caller expects.
| pd | C API primitive descriptor to clone. |
| prim_kind | Expected primitive kind. |
| prop_kind1 | Expected propagation kind (option 1). |
| prop_kind2 | Expected propagation kind (option 2). This value is checked if the check with prop_kind1 fails. |
|
inline |
Returns the engine of the primitive descriptor.
|
inline |
Returns implementation name.
|
inline |
Returns a memory::dim value (same as int64_t).
| what | The value to query. |
|
inline |
Returns a memory descriptor.
| what | The kind of parameter to query; can be dnnl::query::src_md, dnnl::query::dst_md, etc. |
| idx | Index of the parameter. For example, convolution bias can be queried with what = dnnl::query::weights_md and idx = 1. |
|
inline |
Returns a source memory descriptor.
| idx | Source index. |
idx.
|
inline |
Returns a destination memory descriptor.
| idx | Destination index. |
idx.
|
inline |
Returns a weights memory descriptor.
| idx | Weights index. |
idx.
|
inline |
Returns a diff source memory descriptor.
| idx | Diff source index. |
idx.
|
inline |
Returns a diff destination memory descriptor.
| idx | Diff destination index. |
idx.
|
inline |
Returns a diff weights memory descriptor.
| idx | Diff weights index. |
idx.
|
inline |
Returns a source memory descriptor.
|
inline |
Returns a destination memory descriptor.
|
inline |
Returns a weights memory descriptor.
|
inline |
Returns a diff source memory descriptor.
|
inline |
Returns a diff destination memory descriptor.
|
inline |
Returns a diff weights memory descriptor.
|
inline |
Returns the workspace memory descriptor.
|
inline |
Returns the scratchpad memory descriptor.
|
inline |
Returns the engine on which the scratchpad memory is located.
|
inline |
Returns the primitive attributes.
|
inline |
Returns the kind of the primitive descriptor.
|
inlineprotected |
Resets the value of the handle to a clone of a C API primitive descriptor.
| pd | A C API primitive descriptor to clone. |