org.bytedeco.dnnl

Class dnnl_primitive_handle

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.dnnl.dnnl_primitive_handle

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

primitive

@Name(value="dnnl::handle<dnnl_primitive_t>")
 @NoOffset
 @Properties(inherit=dnnl.class)
public class dnnl_primitive_handle
extends Pointer

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
dnnl_primitive_handle() Constructs an empty handle object.
dnnl_primitive_handle(dnnl_primitive_handle arg0) Copy constructor.
dnnl_primitive_handle(dnnl_primitive t)
dnnl_primitive_handle(dnnl_primitive t, boolean weak) Constructs a handle wrapper object from a C API handle.
dnnl_primitive_handle(long size) Native array allocator.
dnnl_primitive_handle(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
boolean	asBoolean() Checks whether the object is not empty.
dnnl_primitive	asDnnl_primitive() Converts a handle to the underlying C API handle type.
boolean	equals(dnnl_primitive_handle other) Equality operator.
dnnl_primitive	get()
dnnl_primitive	get(boolean allow_empty) Returns the underlying C API handle.
dnnl_primitive_handle	getPointer(long i)
boolean	notEquals(dnnl_primitive_handle other) Inequality operator.
dnnl_primitive_handle	position(long position)
dnnl_primitive_handle	put(dnnl_primitive_handle arg0) Assignment operator.
void	reset(dnnl_primitive t)
void	reset(dnnl_primitive t, boolean weak) Resets the handle wrapper objects to wrap a new C API handle.

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

dnnl_primitive_handle

public dnnl_primitive_handle(Pointer p)

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

dnnl_primitive_handle

public dnnl_primitive_handle(long size)

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

dnnl_primitive_handle

public dnnl_primitive_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.

dnnl_primitive_handle

public dnnl_primitive_handle(@Const @ByRef
                             dnnl_primitive_handle arg0)

Copy constructor.

dnnl_primitive_handle

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

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 \c false.

dnnl_primitive_handle

public dnnl_primitive_handle(dnnl_primitive t)

Method Detail

position

public dnnl_primitive_handle position(long position)

Overrides:

position in class Pointer

getPointer

public dnnl_primitive_handle getPointer(long i)

Overrides:

getPointer in class Pointer

put

@ByRef
 @Name(value="operator =")
public dnnl_primitive_handle put(@Const @ByRef
                                                                     dnnl_primitive_handle arg0)

Assignment operator.

reset

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

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 \c false.

reset

public void reset(dnnl_primitive t)

get

public dnnl_primitive get(@Cast(value="bool")
                          boolean allow_empty)

Returns 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.

get

public dnnl_primitive get()

asDnnl_primitive

@Name(value="operator dnnl_primitive_t")
public dnnl_primitive asDnnl_primitive()

Converts 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.

asBoolean

@Cast(value="bool")
 @Name(value="operator bool")
public boolean asBoolean()

Checks whether the object is not empty.

Returns:

Whether the object is not empty.

equals

@Cast(value="bool")
 @Name(value="operator ==")
public boolean equals(@Const @ByRef
                                                                        dnnl_primitive_handle other)

Equality operator.

Parameters:

other - Another handle wrapper.

Returns:

\c true if this and the other handle wrapper manage the same underlying C API handle, and \c false otherwise. Empty handle objects are considered to be equal.

notEquals

@Cast(value="bool")
 @Name(value="operator !=")
public boolean notEquals(@Const @ByRef
                                                                           dnnl_primitive_handle other)

Inequality operator.

Parameters:

other - Another handle wrapper.

Returns:

\c true if this and the other handle wrapper manage different underlying C API handles, and \c false otherwise. Empty handle objects are considered to be equal.