primitive_desc_base (JavaCPP Presets for DNNL 1.6.2-1.5.4 API)

java.lang.Object
- org.bytedeco.javacpp.Pointer
- - org.bytedeco.dnnl.dnnl_primitive_desc_handle
  - - org.bytedeco.dnnl.primitive_desc_base

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

concat.primitive_desc, primitive_desc, reorder.primitive_desc, sum.primitive_desc
```
@Namespace(value="dnnl")
 @Properties(inherit=dnnl.class)
public class primitive_desc_base
extends dnnl_primitive_desc_handle
```
\} dnnl_api_attributes
\addtogroup dnnl_api_primitives_common \{
Base class for all primitive descriptors.

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_base()`
`primitive_desc_base(dnnl_primitive_desc t)`
`primitive_desc_base(dnnl_primitive_desc t, boolean weak)`
`primitive_desc_base(long size)` Native array allocator.
`primitive_desc_base(Pointer p)` Pointer cast constructor.
`primitive_desc_base(primitive_desc_base arg0)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`memory.desc`	`diff_dst_desc()` Returns a diff destination memory descriptor.
`memory.desc`	`diff_dst_desc(int idx)` Returns a diff destination memory descriptor.
`memory.desc`	`diff_src_desc()` Returns a diff source memory descriptor.
`memory.desc`	`diff_src_desc(int idx)` Returns a diff source memory descriptor.
`memory.desc`	`diff_weights_desc()` Returns a diff weights memory descriptor.
`memory.desc`	`diff_weights_desc(int idx)` Returns a diff weights memory descriptor.
`memory.desc`	`dst_desc()` Returns a destination memory descriptor.
`memory.desc`	`dst_desc(int idx)` Returns a destination memory descriptor.
`engine`	`get_engine()` Returns the engine of the primitive descriptor.
`primitive.kind`	`get_kind()` Returns the kind of the primitive descriptor.
`primitive_attr`	`get_primitive_attr()` Returns the primitive attributes.
`primitive_desc_base`	`getPointer(long i)`
`BytePointer`	`impl_info_str()` Returns implementation name.
`primitive_desc_base`	`position(long position)`
`memory.desc`	`query_md(dnnl.query what)`
`memory.desc`	`query_md(dnnl.query what, int idx)` Returns a memory descriptor.
`memory.desc`	`query_md(int what)`
`memory.desc`	`query_md(int what, int idx)`
`long`	`query_s64(dnnl.query what)` Returns a memory::dim value (same as int64_t).
`long`	`query_s64(int what)`
`memory.desc`	`scratchpad_desc()` Returns the scratchpad memory descriptor.
`engine`	`scratchpad_engine()` Returns the engine on which the scratchpad memory is located.
`memory.desc`	`src_desc()` Returns a source memory descriptor.
`memory.desc`	`src_desc(int idx)` Returns a source memory descriptor.
`memory.desc`	`weights_desc()` Returns a weights memory descriptor.
`memory.desc`	`weights_desc(int idx)` Returns a weights memory descriptor.
`memory.desc`	`workspace_desc()` Returns the workspace memory descriptor.

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_base
```
public primitive_desc_base()
```
  - primitive_desc_base
```
public primitive_desc_base(@Const @ByRef
                           primitive_desc_base arg0)
```
  - primitive_desc_base
```
public primitive_desc_base(dnnl_primitive_desc t,
                           @Cast(value="bool")
                           boolean weak)
```
  - primitive_desc_base
```
public primitive_desc_base(dnnl_primitive_desc t)
```
  - primitive_desc_base
```
public primitive_desc_base(Pointer p)
```
    Pointer cast constructor. Invokes Pointer.Pointer(Pointer).
  - primitive_desc_base
```
public primitive_desc_base(long size)
```
    Native array allocator. Access with Pointer.position(long).
- Method Detail
  - position
```
public primitive_desc_base position(long position)
```
    Overrides:
    
    position in class dnnl_primitive_desc_handle
  - getPointer
```
public primitive_desc_base getPointer(long i)
```
    Overrides:
    
    getPointer in class dnnl_primitive_desc_handle
  - get_engine
```
@ByVal
public engine get_engine()
```
    Returns the engine of the primitive descriptor.
    
    Returns:
    
    The engine of the primitive descriptor.
  - impl_info_str
```
@Cast(value="const char*")
public BytePointer impl_info_str()
```
    Returns implementation name.
    
    Returns:
    
    The implementation name.
  - query_s64
```
@Cast(value="dnnl::memory::dim")
public long query_s64(dnnl.query what)
```
    Returns a memory::dim value (same as int64_t).
    
    Parameters:
    
    what - The value to query.
    
    Returns:
    
    The result of the query.
  - query_s64
```
@Cast(value="dnnl::memory::dim")
public long query_s64(@Cast(value="dnnl::query")
                                                        int what)
```
  - query_md
```
@ByVal
public memory.desc query_md(dnnl.query what,
                                    int idx)
```
    Returns a memory descriptor. \note There are also convenience methods #dnnl::primitive_desc_base::src_desc(), #dnnl::primitive_desc_base::dst_desc(), and others.
    
    Parameters:
    
    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.
    
    Returns:
    
    The requested memory descriptor.
  - query_md
```
@ByVal
public memory.desc query_md(dnnl.query what)
```
  - query_md
```
@ByVal
public memory.desc query_md(@Cast(value="dnnl::query")
                                    int what,
                                    int idx)
```
  - query_md
```
@ByVal
public memory.desc query_md(@Cast(value="dnnl::query")
                                    int what)
```
  - src_desc
```
@ByVal
public memory.desc src_desc(int idx)
```
    Returns a source memory descriptor.
    
    Parameters:
    
    idx - Source index.
    
    Returns:
    
    Source memory descriptor.
  - dst_desc
```
@ByVal
public memory.desc dst_desc(int idx)
```
    Returns a destination memory descriptor.
    
    Parameters:
    
    idx - Destination index.
    
    Returns:
    
    Destination memory descriptor.
  - weights_desc
```
@ByVal
public memory.desc weights_desc(int idx)
```
    Returns a weights memory descriptor.
    
    Parameters:
    
    idx - Weights index.
    
    Returns:
    
    Weights memory descriptor.
  - diff_src_desc
```
@ByVal
public memory.desc diff_src_desc(int idx)
```
    Returns a diff source memory descriptor.
    
    Parameters:
    
    idx - Diff source index.
    
    Returns:
    
    Diff source memory descriptor.
  - diff_dst_desc
```
@ByVal
public memory.desc diff_dst_desc(int idx)
```
    Returns a diff destination memory descriptor.
    
    Parameters:
    
    idx - Diff destination index.
    
    Returns:
    
    Diff destination memory descriptor.
  - diff_weights_desc
```
@ByVal
public memory.desc diff_weights_desc(int idx)
```
    Returns a diff weights memory descriptor.
    
    Parameters:
    
    idx - Diff weights index.
    
    Returns:
    
    Diff weights memory descriptor.
  - src_desc
```
@ByVal
public memory.desc src_desc()
```
    Returns a source memory descriptor.
    
    Returns:
    
    Source memory descriptor.
  - dst_desc
```
@ByVal
public memory.desc dst_desc()
```
    Returns a destination memory descriptor.
    
    Returns:
    
    Destination memory descriptor.
  - weights_desc
```
@ByVal
public memory.desc weights_desc()
```
    Returns a weights memory descriptor.
    
    Returns:
    
    Weights memory descriptor.
  - diff_src_desc
```
@ByVal
public memory.desc diff_src_desc()
```
    Returns a diff source memory descriptor.
    
    Returns:
    
    Diff source memory descriptor.
  - diff_dst_desc
```
@ByVal
public memory.desc diff_dst_desc()
```
    Returns a diff destination memory descriptor.
    
    Returns:
    
    Diff destination memory descriptor.
  - diff_weights_desc
```
@ByVal
public memory.desc diff_weights_desc()
```
    Returns a diff weights memory descriptor.
    
    Returns:
    
    Diff weights memory descriptor.
  - workspace_desc
```
@ByVal
public memory.desc workspace_desc()
```
    Returns the workspace memory descriptor.
    
    Returns:
    
    Workspace memory descriptor.
  - scratchpad_desc
```
@ByVal
public memory.desc scratchpad_desc()
```
    Returns the scratchpad memory descriptor.
    
    Returns:
    
    scratchpad memory descriptor.
    
    See Also:
    
    dev_guide_attributes_scratchpad
  - scratchpad_engine
```
@ByVal
public engine scratchpad_engine()
```
    Returns the engine on which the scratchpad memory is located.
    
    Returns:
    
    The engine on which the scratchpad memory is located.
  - get_primitive_attr
```
@ByVal
public primitive_attr get_primitive_attr()
```
    Returns the primitive attributes.
    
    Returns:
    
    The primitive attributes.
  - get_kind
```
public primitive.kind get_kind()
```
    Returns the kind of the primitive descriptor.
    
    Returns:
    
    The kind of the primitive descriptor.

Class primitive_desc_base

Nested Class Summary

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

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.bytedeco.dnnl.dnnl_primitive_desc_handle

Methods inherited from class org.bytedeco.javacpp.Pointer

Methods inherited from class java.lang.Object

Constructor Detail

primitive_desc_base

primitive_desc_base

primitive_desc_base

primitive_desc_base

primitive_desc_base

primitive_desc_base

Method Detail

position

getPointer

get_engine

impl_info_str

query_s64

query_s64

query_md

query_md

query_md

query_md

src_desc

dst_desc

weights_desc

diff_src_desc

diff_dst_desc

diff_weights_desc

src_desc

dst_desc

weights_desc

diff_src_desc

diff_dst_desc

diff_weights_desc

workspace_desc

scratchpad_desc

scratchpad_engine

get_primitive_attr

get_kind