org.bytedeco.dnnl

Class primitive_desc

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.dnnl.dnnl_primitive_desc_handle

org.bytedeco.dnnl.primitive_desc_base

org.bytedeco.dnnl.primitive_desc

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

batch_normalization_backward.primitive_desc, batch_normalization_forward.primitive_desc, binary.primitive_desc, convolution_backward_data.primitive_desc, convolution_backward_weights.primitive_desc, convolution_forward.primitive_desc, deconvolution_backward_data.primitive_desc, deconvolution_backward_weights.primitive_desc, deconvolution_forward.primitive_desc, eltwise_backward.primitive_desc, eltwise_forward.primitive_desc, inner_product_backward_data.primitive_desc, inner_product_backward_weights.primitive_desc, inner_product_forward.primitive_desc, layer_normalization_backward.primitive_desc, layer_normalization_forward.primitive_desc, logsoftmax_backward.primitive_desc, logsoftmax_forward.primitive_desc, lrn_backward.primitive_desc, lrn_forward.primitive_desc, matmul.primitive_desc, pooling_backward.primitive_desc, pooling_forward.primitive_desc, resampling_backward.primitive_desc, resampling_forward.primitive_desc, rnn_primitive_desc_base, shuffle_backward.primitive_desc, shuffle_forward.primitive_desc, softmax_backward.primitive_desc, softmax_forward.primitive_desc

@Name(value="dnnl::primitive_desc")
 @NoOffset
 @Properties(inherit=dnnl.class)
public class primitive_desc
extends primitive_desc_base

\} dnnl_api_sum

\addtogroup dnnl_api_primitives_common \{

A base class for descriptors of all primitives that have an operation descriptor and that support iteration over multiple implementations.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
primitive_desc()
primitive_desc(const_dnnl_op_desc_t desc, primitive_attr attr, engine aengine, dnnl_primitive_desc hint_fwd_pd)
primitive_desc(const_dnnl_op_desc_t desc, primitive_attr attr, engine aengine, dnnl_primitive_desc hint_fwd_pd, boolean allow_empty) Constructs a primitive descriptor.
primitive_desc(dnnl_primitive_desc t)
primitive_desc(dnnl_primitive_desc t, boolean weak)
primitive_desc(long size) Native array allocator.
primitive_desc(Pointer p) Pointer cast constructor.
primitive_desc(primitive_desc arg0)

Method Summary

Modifier and Type	Method and Description
primitive_desc	getPointer(long i)
boolean	next_impl() Advances the primitive iterator to the next implementation.
primitive_desc	position(long position)

Methods inherited from class org.bytedeco.dnnl.primitive_desc_base

diff_dst_desc, diff_dst_desc, diff_src_desc, diff_src_desc, diff_weights_desc, diff_weights_desc, dst_desc, dst_desc, get_engine, get_kind, get_primitive_attr, impl_info_str, query_md, query_md, query_md, query_md, query_s64, query_s64, scratchpad_desc, scratchpad_engine, src_desc, src_desc, weights_desc, weights_desc, workspace_desc

Methods inherited from class org.bytedeco.dnnl.dnnl_primitive_desc_handle

asBoolean, asDnnl_primitive_desc, equals, get, get, notEquals, put, reset, reset

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

primitive_desc

public primitive_desc()

primitive_desc

public primitive_desc(@Const @ByRef
                      primitive_desc arg0)

primitive_desc

public primitive_desc(dnnl_primitive_desc t,
                      @Cast(value="bool")
                      boolean weak)

primitive_desc

public primitive_desc(dnnl_primitive_desc t)

primitive_desc

public primitive_desc(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

primitive_desc

public primitive_desc(long size)

Native array allocator. Access with Pointer.position(long).

primitive_desc

public primitive_desc(const_dnnl_op_desc_t desc,
                      @Const
                      primitive_attr attr,
                      @Const @ByRef
                      engine aengine,
                      @Const
                      dnnl_primitive_desc hint_fwd_pd,
                      @Cast(value="bool")
                      boolean allow_empty)

Constructs a primitive descriptor. \note If \p allow_empty is true, the constructor does not throw if a primitive descriptor cannot be created. But calling next_impl() in this case will throw. \note This is a low-level implementation detail that is typically not needed in application code.

Parameters:

desc - Constant C API operation descriptor.

attr - Pointer to primitive attributes. It is safe to pass nullptr to indicate absence of attributes.

aengine - Engine to use.

hint_fwd_pd - C API primitive descriptor for a forward propagation primitive. It is used as a hint for deciding which memory format to use for backward propagation or weights gradient.

allow_empty - A flag signifying whether construction is allowed to fail without throwing an exception. In this case an empty object will be produced. This flag is optional and defaults to false.

primitive_desc

public primitive_desc(const_dnnl_op_desc_t desc,
                      @Const
                      primitive_attr attr,
                      @Const @ByRef
                      engine aengine,
                      @Const
                      dnnl_primitive_desc hint_fwd_pd)

Method Detail

position

public primitive_desc position(long position)

Overrides:

position in class primitive_desc_base

getPointer

public primitive_desc getPointer(long i)

Overrides:

getPointer in class primitive_desc_base

next_impl

@Cast(value="bool")
public boolean next_impl()

Advances the primitive iterator to the next implementation.

Returns:

\c true on success, and \c false if the last implementation reached, and the primitive descriptor itself is kept unchanged