Visible to Intel only — GUID: GUID-69A7C2F0-885E-40D5-AE21-6CCDC6089136
Abs
AbsBackward
Add
AvgPool
AvgPoolBackward
BatchNormForwardTraining
BatchNormInference
BatchNormTrainingBackward
BiasAdd
BiasAddBackward
Clamp
ClampBackward
Concat
Convolution
ConvolutionBackwardData
ConvolutionBackwardWeights
ConvTranspose
ConvTransposeBackwardData
ConvTransposeBackwardWeights
Dequantize
Divide
DynamicDequantize
DynamicQuantize
Elu
EluBackward
End
Exp
GroupNorm
GELU
GELUBackward
HardSigmoid
HardSigmoidBackward
HardSwish
HardSwishBackward
Interpolate
InterpolateBackward
LayerNorm
LayerNormBackward
LeakyReLU
Log
LogSoftmax
LogSoftmaxBackward
MatMul
Maximum
MaxPool
MaxPoolBackward
Minimum
Mish
MishBackward
Multiply
Pow
PReLU
PReLUBackward
Quantize
Reciprocal
ReduceL1
ReduceL2
ReduceMax
ReduceMean
ReduceMin
ReduceProd
ReduceSum
ReLU
ReLUBackward
Reorder
Round
Select
Sigmoid
SigmoidBackward
SoftMax
SoftMaxBackward
SoftPlus
SoftPlusBackward
Sqrt
SqrtBackward
Square
SquaredDifference
StaticReshape
StaticTranspose
Subtract
Tanh
TanhBackward
TypeCast
Wildcard
enum dnnl_alg_kind_t
enum dnnl_normalization_flags_t
enum dnnl_primitive_kind_t
enum dnnl_prop_kind_t
enum dnnl_query_t
enum dnnl::normalization_flags
enum dnnl::query
struct dnnl_exec_arg_t
struct dnnl_primitive
struct dnnl_primitive_desc
struct dnnl::primitive
struct dnnl::primitive_desc
struct dnnl::primitive_desc_base
enum dnnl_rnn_direction_t
enum dnnl_rnn_flags_t
enum dnnl::rnn_direction
enum dnnl::rnn_flags
struct dnnl::augru_backward
struct dnnl::augru_forward
struct dnnl::gru_backward
struct dnnl::gru_forward
struct dnnl::lbr_augru_backward
struct dnnl::lbr_augru_forward
struct dnnl::lbr_gru_backward
struct dnnl::lbr_gru_forward
struct dnnl::lstm_backward
struct dnnl::lstm_forward
struct dnnl::rnn_primitive_desc_base
struct dnnl::vanilla_rnn_backward
struct dnnl::vanilla_rnn_forward
Visible to Intel only — GUID: GUID-69A7C2F0-885E-40D5-AE21-6CCDC6089136
template struct dnnl::handle
Overview
oneDNN C API handle wrapper class. More…
#include <dnnl_common.hpp>
template <typename T, typename traits = handle_traits<T>>
struct handle
{
// construction
handle();
handle(const handle<T, traits>&);
handle(handle<T, traits>&&);
handle(T t, bool weak = false);
// 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;
};
// direct descendants
struct attr_params;
struct brgemm;
struct desc;
struct engine;
struct memory;
struct post_ops;
struct primitive;
struct primitive_attr;
struct primitive_desc_base;
struct stream;
struct transform;Detailed Documentation
oneDNN C API handle wrapper class.
This class is used as the base class for primitive (dnnl::primitive), engine (dnnl::engine), and stream (dnnl::stream) classes, as well as others. An object of the dnnl::handle class can be passed by value.
A handle can be weak, in which case it follows std::weak_ptr semantics. Otherwise, it follows std::shared_ptr semantics.
NOTE:
The implementation stores oneDNN C API handles in a std::shared_ptr with deleter set to a dummy function in the weak mode.
Construction
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. |
Methods
handle<T, traits>& operator = (const handle<T, traits>&)Assignment operator.
handle<T, traits>& operator = (handle<T, traits>&&)Move assignment operator.
void reset(T t, bool weak = false)Resets the handle wrapper objects to wrap a new C API handle.
Parameters:
t |
The new value of the C API handle. |
weak |
A flag specifying whether the wrapper should be weak; defaults to false. |
T get(bool allow_empty = false) constReturns the underlying C API handle.
Parameters:
allow_empty |
A flag signifying whether the method is allowed to return an empty (null) object without throwing an exception. |
Returns:
The underlying C API handle.
operator T () constConverts a handle to the underlying C API handle type.
Does not throw and returns nullptr if the object is empty.
Returns:
The underlying C API handle.
operator bool () constChecks whether the object is not empty.
Returns:
Whether the object is not empty.
bool operator == (const handle<T, traits>& other) constEquality operator.
Parameters:
other |
Another handle wrapper. |
Returns:
true if this and the other handle wrapper manage the same underlying C API handle, and false otherwise. Empty handle objects are considered to be equal.
bool operator != (const handle& other) constInequality operator.
Parameters:
other |
Another handle wrapper. |
Returns:
true if this and the other handle wrapper manage different underlying C API handles, and false otherwise. Empty handle objects are considered to be equal.