org.bytedeco.dnnl

Class eltwise_backward.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

org.bytedeco.dnnl.eltwise_backward.primitive_desc

All Implemented Interfaces:

AutoCloseable

Enclosing class:

eltwise_backward

public static class eltwise_backward.primitive_desc
extends primitive_desc

Primitive descriptor for eltwise backward propagation.

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() Default constructor.
primitive_desc(dnnl_primitive_desc pd) Constructs a primitive descriptor for an eltwise backward propagation primitive from a C API primitive descriptor that must have a matching kind.
primitive_desc(engine aengine, dnnl.algorithm aalgorithm, memory.desc diff_src_desc, memory.desc diff_dst_desc, memory.desc data_desc, eltwise_forward.primitive_desc hint_fwd_pd)
primitive_desc(engine aengine, dnnl.algorithm aalgorithm, memory.desc diff_src_desc, memory.desc diff_dst_desc, memory.desc data_desc, eltwise_forward.primitive_desc hint_fwd_pd, primitive_attr attr, boolean allow_empty) Constructs a primitive descriptor for an elementwise backward propagation primitive with an alpha parameter.
primitive_desc(engine aengine, dnnl.algorithm aalgorithm, memory.desc diff_src_desc, memory.desc diff_dst_desc, memory.desc data_desc, float alpha, eltwise_forward.primitive_desc hint_fwd_pd)
primitive_desc(engine aengine, dnnl.algorithm aalgorithm, memory.desc diff_src_desc, memory.desc diff_dst_desc, memory.desc data_desc, float alpha, eltwise_forward.primitive_desc hint_fwd_pd, primitive_attr attr, boolean allow_empty) Constructs a primitive descriptor for an elementwise backward propagation primitive with an alpha parameter.
primitive_desc(engine aengine, dnnl.algorithm aalgorithm, memory.desc diff_src_desc, memory.desc diff_dst_desc, memory.desc data_desc, float alpha, float beta, eltwise_forward.primitive_desc hint_fwd_pd)
primitive_desc(engine aengine, dnnl.algorithm aalgorithm, memory.desc diff_src_desc, memory.desc diff_dst_desc, memory.desc data_desc, float alpha, float beta, eltwise_forward.primitive_desc hint_fwd_pd, primitive_attr attr, boolean allow_empty) Constructs a primitive descriptor for an elementwise backward propagation primitive with an alpha and beta parameters.
primitive_desc(engine aengine, int aalgorithm, memory.desc diff_src_desc, memory.desc diff_dst_desc, memory.desc data_desc, eltwise_forward.primitive_desc hint_fwd_pd)
primitive_desc(engine aengine, int aalgorithm, memory.desc diff_src_desc, memory.desc diff_dst_desc, memory.desc data_desc, eltwise_forward.primitive_desc hint_fwd_pd, primitive_attr attr, boolean allow_empty)
primitive_desc(engine aengine, int aalgorithm, memory.desc diff_src_desc, memory.desc diff_dst_desc, memory.desc data_desc, float alpha, eltwise_forward.primitive_desc hint_fwd_pd)
primitive_desc(engine aengine, int aalgorithm, memory.desc diff_src_desc, memory.desc diff_dst_desc, memory.desc data_desc, float alpha, eltwise_forward.primitive_desc hint_fwd_pd, primitive_attr attr, boolean allow_empty)
primitive_desc(engine aengine, int aalgorithm, memory.desc diff_src_desc, memory.desc diff_dst_desc, memory.desc data_desc, float alpha, float beta, eltwise_forward.primitive_desc hint_fwd_pd)
primitive_desc(engine aengine, int aalgorithm, memory.desc diff_src_desc, memory.desc diff_dst_desc, memory.desc data_desc, float alpha, float beta, eltwise_forward.primitive_desc hint_fwd_pd, primitive_attr attr, boolean allow_empty)
primitive_desc(long size) Native array allocator.
primitive_desc(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
memory.desc	diff_dst_desc() \copydoc dnnl::primitive_desc_base::diff_dst_desc()const
memory.desc	diff_src_desc() \copydoc dnnl::primitive_desc_base::diff_src_desc()const
dnnl.algorithm	get_algorithm() \copydoc dnnl::primitive_desc_base::get_algorithm()const
float	get_alpha() \copydoc dnnl::primitive_desc_base::get_alpha()const
float	get_beta() \copydoc dnnl::primitive_desc_base::get_beta()const
dnnl.prop_kind	get_prop_kind() \copydoc dnnl::primitive_desc_base::get_prop_kind()const
eltwise_backward.primitive_desc	getPointer(long i)
eltwise_backward.primitive_desc	position(long position)
memory.desc	src_desc() \copydoc dnnl::primitive_desc_base::src_desc()const

Methods inherited from class org.bytedeco.dnnl.primitive_desc

next_impl

Methods inherited from class org.bytedeco.dnnl.primitive_desc_base

diff_dst_desc, diff_src_desc, diff_weights_desc, diff_weights_desc, dst_desc, dst_desc, get_activation_kind, get_axis, get_cache_blob_id, get_cell_kind, get_dilations, get_direction, get_engine, get_epsilon, get_factors, get_group_size, get_k, get_kernel, get_kind, get_local_size, get_p, get_padding_l, get_padding_r, get_primitive_attr, get_strides, impl_info_str, query_md, query_md, query_md, query_md, query_s64, query_s64, scratchpad_desc, scratchpad_engine, 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, 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_desc

public primitive_desc(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

primitive_desc

public primitive_desc(long size)

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

primitive_desc

public primitive_desc()

Default constructor. Produces an empty object.

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      dnnl.algorithm aalgorithm,
                      @Const @ByRef
                      memory.desc diff_src_desc,
                      @Const @ByRef
                      memory.desc diff_dst_desc,
                      @Const @ByRef
                      memory.desc data_desc,
                      @Const @ByRef
                      eltwise_forward.primitive_desc hint_fwd_pd,
                      @Const @ByRef(nullValue="dnnl::primitive_attr()")
                      primitive_attr attr,
                      @Cast(value="bool")
                      boolean allow_empty)

Constructs a primitive descriptor for an elementwise backward propagation primitive with an alpha parameter.

Parameters:

aengine - Engine to use.

aalgorithm - Elementwise algorithm kind.

diff_src_desc - Diff source memory descriptor.

diff_dst_desc - Diff destination memory descriptor.

data_desc - Destination memory descriptor if one of the "use_dst_for_bwd" algorithms are used (such as #dnnl_eltwise_relu_use_dst_for_bwd), source memory descriptor otherwise.

hint_fwd_pd - Primitive descriptor for an elementwise forward propagation primitive. It is used as a hint for deciding which memory format to use.

attr - Primitive attributes to use. Attributes are optional and default to empty attributes.

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 @ByRef
                      engine aengine,
                      dnnl.algorithm aalgorithm,
                      @Const @ByRef
                      memory.desc diff_src_desc,
                      @Const @ByRef
                      memory.desc diff_dst_desc,
                      @Const @ByRef
                      memory.desc data_desc,
                      @Const @ByRef
                      eltwise_forward.primitive_desc hint_fwd_pd)

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      @Cast(value="dnnl::algorithm")
                      int aalgorithm,
                      @Const @ByRef
                      memory.desc diff_src_desc,
                      @Const @ByRef
                      memory.desc diff_dst_desc,
                      @Const @ByRef
                      memory.desc data_desc,
                      @Const @ByRef
                      eltwise_forward.primitive_desc hint_fwd_pd,
                      @Const @ByRef(nullValue="dnnl::primitive_attr()")
                      primitive_attr attr,
                      @Cast(value="bool")
                      boolean allow_empty)

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      @Cast(value="dnnl::algorithm")
                      int aalgorithm,
                      @Const @ByRef
                      memory.desc diff_src_desc,
                      @Const @ByRef
                      memory.desc diff_dst_desc,
                      @Const @ByRef
                      memory.desc data_desc,
                      @Const @ByRef
                      eltwise_forward.primitive_desc hint_fwd_pd)

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      dnnl.algorithm aalgorithm,
                      @Const @ByRef
                      memory.desc diff_src_desc,
                      @Const @ByRef
                      memory.desc diff_dst_desc,
                      @Const @ByRef
                      memory.desc data_desc,
                      float alpha,
                      @Const @ByRef
                      eltwise_forward.primitive_desc hint_fwd_pd,
                      @Const @ByRef(nullValue="dnnl::primitive_attr()")
                      primitive_attr attr,
                      @Cast(value="bool")
                      boolean allow_empty)

Constructs a primitive descriptor for an elementwise backward propagation primitive with an alpha parameter.

Parameters:

aengine - Engine to use.

aalgorithm - Elementwise algorithm kind.

diff_src_desc - Diff source memory descriptor.

diff_dst_desc - Diff destination memory descriptor.

data_desc - Destination memory descriptor if one of the "use_dst_for_bwd" algorithms are used (such as #dnnl_eltwise_relu_use_dst_for_bwd), source memory descriptor otherwise.

alpha - The alpha parameter for the elementwise operation. Specific meaning depends on the algorithm.

hint_fwd_pd - Primitive descriptor for an elementwise forward propagation primitive. It is used as a hint for deciding which memory format to use.

attr - Primitive attributes to use. Attributes are optional and default to empty attributes.

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 @ByRef
                      engine aengine,
                      dnnl.algorithm aalgorithm,
                      @Const @ByRef
                      memory.desc diff_src_desc,
                      @Const @ByRef
                      memory.desc diff_dst_desc,
                      @Const @ByRef
                      memory.desc data_desc,
                      float alpha,
                      @Const @ByRef
                      eltwise_forward.primitive_desc hint_fwd_pd)

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      @Cast(value="dnnl::algorithm")
                      int aalgorithm,
                      @Const @ByRef
                      memory.desc diff_src_desc,
                      @Const @ByRef
                      memory.desc diff_dst_desc,
                      @Const @ByRef
                      memory.desc data_desc,
                      float alpha,
                      @Const @ByRef
                      eltwise_forward.primitive_desc hint_fwd_pd,
                      @Const @ByRef(nullValue="dnnl::primitive_attr()")
                      primitive_attr attr,
                      @Cast(value="bool")
                      boolean allow_empty)

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      @Cast(value="dnnl::algorithm")
                      int aalgorithm,
                      @Const @ByRef
                      memory.desc diff_src_desc,
                      @Const @ByRef
                      memory.desc diff_dst_desc,
                      @Const @ByRef
                      memory.desc data_desc,
                      float alpha,
                      @Const @ByRef
                      eltwise_forward.primitive_desc hint_fwd_pd)

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      dnnl.algorithm aalgorithm,
                      @Const @ByRef
                      memory.desc diff_src_desc,
                      @Const @ByRef
                      memory.desc diff_dst_desc,
                      @Const @ByRef
                      memory.desc data_desc,
                      float alpha,
                      float beta,
                      @Const @ByRef
                      eltwise_forward.primitive_desc hint_fwd_pd,
                      @Const @ByRef(nullValue="dnnl::primitive_attr()")
                      primitive_attr attr,
                      @Cast(value="bool")
                      boolean allow_empty)

Constructs a primitive descriptor for an elementwise backward propagation primitive with an alpha and beta parameters.

Parameters:

aengine - Engine to use.

aalgorithm - Elementwise algorithm kind.

diff_src_desc - Diff source memory descriptor.

diff_dst_desc - Diff destination memory descriptor.

data_desc - Destination memory descriptor if one of the "use_dst_for_bwd" algorithms are used (such as #dnnl_eltwise_relu_use_dst_for_bwd), source memory descriptor otherwise.

alpha - The alpha parameter for the elementwise operation. Specific meaning depends on the algorithm.

beta - The beta parameter for the elementwise operation. Specific meaning depends on the algorithm.

hint_fwd_pd - Primitive descriptor for an elementwise forward propagation primitive. It is used as a hint for deciding which memory format to use.

attr - Primitive attributes to use. Attributes are optional and default to empty attributes.

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 @ByRef
                      engine aengine,
                      dnnl.algorithm aalgorithm,
                      @Const @ByRef
                      memory.desc diff_src_desc,
                      @Const @ByRef
                      memory.desc diff_dst_desc,
                      @Const @ByRef
                      memory.desc data_desc,
                      float alpha,
                      float beta,
                      @Const @ByRef
                      eltwise_forward.primitive_desc hint_fwd_pd)

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      @Cast(value="dnnl::algorithm")
                      int aalgorithm,
                      @Const @ByRef
                      memory.desc diff_src_desc,
                      @Const @ByRef
                      memory.desc diff_dst_desc,
                      @Const @ByRef
                      memory.desc data_desc,
                      float alpha,
                      float beta,
                      @Const @ByRef
                      eltwise_forward.primitive_desc hint_fwd_pd,
                      @Const @ByRef(nullValue="dnnl::primitive_attr()")
                      primitive_attr attr,
                      @Cast(value="bool")
                      boolean allow_empty)

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      @Cast(value="dnnl::algorithm")
                      int aalgorithm,
                      @Const @ByRef
                      memory.desc diff_src_desc,
                      @Const @ByRef
                      memory.desc diff_dst_desc,
                      @Const @ByRef
                      memory.desc data_desc,
                      float alpha,
                      float beta,
                      @Const @ByRef
                      eltwise_forward.primitive_desc hint_fwd_pd)

primitive_desc

public primitive_desc(dnnl_primitive_desc pd)

Constructs a primitive descriptor for an eltwise backward propagation primitive from a C API primitive descriptor that must have a matching kind.

Parameters:

pd - C API primitive descriptor for an eltwise backward propagation primitive.

Method Detail

position

public eltwise_backward.primitive_desc position(long position)

Overrides:

position in class primitive_desc

getPointer

public eltwise_backward.primitive_desc getPointer(long i)

Overrides:

getPointer in class primitive_desc

src_desc

@ByVal
public memory.desc src_desc()

\copydoc dnnl::primitive_desc_base::src_desc()const

Overrides:

src_desc in class primitive_desc_base

Returns:

Source memory descriptor.

diff_src_desc

@ByVal
public memory.desc diff_src_desc()

\copydoc dnnl::primitive_desc_base::diff_src_desc()const

Overrides:

diff_src_desc in class primitive_desc_base

Returns:

Diff source memory descriptor.

diff_dst_desc

@ByVal
public memory.desc diff_dst_desc()

\copydoc dnnl::primitive_desc_base::diff_dst_desc()const

Overrides:

diff_dst_desc in class primitive_desc_base

Returns:

Diff destination memory descriptor.

get_algorithm

public dnnl.algorithm get_algorithm()

\copydoc dnnl::primitive_desc_base::get_algorithm()const

Overrides:

get_algorithm in class primitive_desc_base

Returns:

An algorithm kind.

get_prop_kind

public dnnl.prop_kind get_prop_kind()

\copydoc dnnl::primitive_desc_base::get_prop_kind()const

Overrides:

get_prop_kind in class primitive_desc_base

Returns:

A propagation kind.

get_alpha

public float get_alpha()

\copydoc dnnl::primitive_desc_base::get_alpha()const

Overrides:

get_alpha in class primitive_desc_base

Returns:

An alpha.

get_beta

public float get_beta()

\copydoc dnnl::primitive_desc_base::get_beta()const

Overrides:

get_beta in class primitive_desc_base

Returns:

A beta.