org.bytedeco.dnnl

Class primitive

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.dnnl.dnnl_primitive_handle

org.bytedeco.dnnl.primitive

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

augru_backward, augru_forward, batch_normalization_backward, batch_normalization_forward, binary, concat, convolution_backward_data, convolution_backward_weights, convolution_forward, deconvolution_backward_data, deconvolution_backward_weights, deconvolution_forward, eltwise_backward, eltwise_forward, group_normalization_backward, group_normalization_forward, gru_backward, gru_forward, inner_product_backward_data, inner_product_backward_weights, inner_product_forward, layer_normalization_backward, layer_normalization_forward, lbr_augru_backward, lbr_augru_forward, lbr_gru_backward, lbr_gru_forward, lrn_backward, lrn_forward, lstm_backward, lstm_forward, matmul, pooling_backward, pooling_forward, prelu_backward, prelu_forward, reduction, reorder, resampling_backward, resampling_forward, shuffle_backward, shuffle_forward, softmax_backward, softmax_forward, sum, vanilla_rnn_backward, vanilla_rnn_forward

@Namespace(value="dnnl")
 @Properties(inherit=dnnl.class)
public class primitive
extends dnnl_primitive_handle

\addtogroup dnnl_api_primitives Primitives Compute primitives

See Also:

dev_guide_basic_concepts \{

\addtogroup dnnl_api_primitives_common Common Common operations to create, destroy and inspect primitives \{

Base class for all computational primitives.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	primitive.kind Kinds of primitives supported by the library.

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()
primitive(dnnl_primitive_desc c_pd) Constructs a primitive from a C API primitive descriptor.
primitive(dnnl_primitive_desc c_pd, byte[] cache_blob)
primitive(dnnl_primitive_desc c_pd, ByteBuffer cache_blob)
primitive(dnnl_primitive_desc c_pd, BytePointer cache_blob) Constructs a primitive from a C API primitive descriptor and a cache blob.
primitive(dnnl_primitive t)
primitive(dnnl_primitive t, boolean weak)
primitive(long size) Native array allocator.
primitive(Pointer p) Pointer cast constructor.
primitive(primitive_desc pd) Constructs a primitive from a primitive descriptor.
primitive(primitive_desc pd, byte[] cache_blob)
primitive(primitive_desc pd, ByteBuffer cache_blob)
primitive(primitive_desc pd, BytePointer cache_blob) Constructs a primitive from a primitive descriptor and a cache blob.
primitive(primitive arg0)

Method Summary

Modifier and Type	Method and Description
void	execute(stream astream, IntMemoryMap args) Executes computations specified by the primitive in a specified stream.
BytePointer	get_cache_blob() Returns a cache blob for the primitive.
dnnl_primitive_desc	get_dnnl_primitive_desc() Returns the C API primitive descriptor of the underlying C API primitive.
primitive.kind	get_kind() Returns the kind of the primitive.
primitive	getPointer(long i)
primitive	position(long position)

Methods inherited from class org.bytedeco.dnnl.dnnl_primitive_handle

asBoolean, asDnnl_primitive, 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, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, 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

public primitive()

primitive

public primitive(@Const @ByRef
                 primitive arg0)

primitive

public primitive(dnnl_primitive t,
                 @Cast(value="bool")
                 boolean weak)

primitive

public primitive(dnnl_primitive t)

primitive

public primitive(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

primitive

public primitive(long size)

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

primitive

public primitive(@Const
                 dnnl_primitive_desc c_pd)

Constructs a primitive from a C API primitive descriptor.

Parameters:

c_pd - C API primitive descriptor.

primitive

public primitive(@Const
                 dnnl_primitive_desc c_pd,
                 @Cast(value="uint8_t*") @StdVector
                 BytePointer cache_blob)

Constructs a primitive from a C API primitive descriptor and a cache blob.

Parameters:

c_pd - C API primitive descriptor.

cache_blob - Cache blob.

primitive

public primitive(@Const
                 dnnl_primitive_desc c_pd,
                 @Cast(value="uint8_t*") @StdVector
                 ByteBuffer cache_blob)

primitive

public primitive(@Const
                 dnnl_primitive_desc c_pd,
                 @Cast(value="uint8_t*") @StdVector
                 byte[] cache_blob)

primitive

public primitive(@Const @ByRef
                 primitive_desc pd)

Constructs a primitive from a primitive descriptor.

Parameters:

pd - Primitive descriptor.

primitive

public primitive(@Const @ByRef
                 primitive_desc pd,
                 @Cast(value="uint8_t*") @StdVector
                 BytePointer cache_blob)

Constructs a primitive from a primitive descriptor and a cache blob.

Parameters:

pd - Primitive descriptor.

cache_blob - Cache blob.

primitive

public primitive(@Const @ByRef
                 primitive_desc pd,
                 @Cast(value="uint8_t*") @StdVector
                 ByteBuffer cache_blob)

primitive

public primitive(@Const @ByRef
                 primitive_desc pd,
                 @Cast(value="uint8_t*") @StdVector
                 byte[] cache_blob)

Method Detail

position

public primitive position(long position)

Overrides:

position in class dnnl_primitive_handle

getPointer

public primitive getPointer(long i)

Overrides:

getPointer in class dnnl_primitive_handle

get_dnnl_primitive_desc

@Name(value="get_primitive_desc")
 @Const
public dnnl_primitive_desc get_dnnl_primitive_desc()

Returns the C API primitive descriptor of the underlying C API primitive.

Returns:

The underlying C API primitive descriptor.

get_kind

public primitive.kind get_kind()

Returns the kind of the primitive.

Returns:

The primitive kind.

get_cache_blob

@Cast(value="uint8_t*")
 @StdVector
public BytePointer get_cache_blob()

Returns a cache blob for the primitive.

Returns:

Vector containing the cache blob. \note The cache blob can be empty. It's the user's responsibility to check whether it's empty prior to passing it to the primitive constructor.

execute

public void execute(@Const @ByRef
                    stream astream,
                    @Const @ByRef
                    IntMemoryMap args)

Executes computations specified by the primitive in a specified stream. Arguments are passed via an arguments map containing pairs. The index must be one of the DNNL_ARG_* values such as DNNL_ARG_SRC, and the memory must have a memory descriptor matching the one returned by primitive_desc::query_md(#query::exec_arg_md, index) unless using dynamic shapes (see #DNNL_RUNTIME_DIM_VAL).

Parameters:

astream - Stream object. The stream must belong to the same engine as the primitive.

args - Arguments map.