org.nd4j.nativeblas

Class OpaqueDataBuffer

java.lang.Object

org.bytedeco.javacpp.Pointer

org.nd4j.nativeblas.OpaqueDataBuffer

All Implemented Interfaces:

AutoCloseable

public class OpaqueDataBuffer
extends org.bytedeco.javacpp.Pointer

Nested Class Summary

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

org.bytedeco.javacpp.Pointer.CustomDeallocator, org.bytedeco.javacpp.Pointer.Deallocator, org.bytedeco.javacpp.Pointer.NativeDeallocator, org.bytedeco.javacpp.Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
OpaqueDataBuffer(org.bytedeco.javacpp.Pointer p)

Method Summary

Modifier and Type	Method and Description
static OpaqueDataBuffer	allocateDataBuffer(long numElements, @NonNull DataType dataType, boolean allocateBoth) This method allocates new InteropDataBuffer and returns pointer to it
void	closeBuffer() This method releases underlying buffer
OpaqueDataBuffer	createView(long bytesLength, long bytesOffset) This method creates a view out of this InteropDataBuffer
int	deviceId() This method returns deviceId of this DataBuffer
void	expand(long numElements) This method expands buffer, and copies content to the new buffer PLEASE NOTE: if InteropDataBuffer doesn't own actual buffers - original pointers won't be released
static OpaqueDataBuffer	externalizedDataBuffer(long numElements, @NonNull DataType dataType, org.bytedeco.javacpp.Pointer primary, org.bytedeco.javacpp.Pointer special)
org.bytedeco.javacpp.Pointer	primaryBuffer() This method returns pointer to linear buffer, primary one.
void	setPrimaryBuffer(org.bytedeco.javacpp.Pointer ptr, long numElements) This method allows to set external pointer as primary buffer.
void	setSpecialBuffer(org.bytedeco.javacpp.Pointer ptr, long numElements) This method allows to set external pointer as primary buffer.
org.bytedeco.javacpp.Pointer	specialBuffer() This method returns pointer to special buffer, device one, if any.
void	syncToPrimary() This method synchronizes host memory
void	syncToSpecial() This method synchronizes device memory

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

OpaqueDataBuffer

public OpaqueDataBuffer(org.bytedeco.javacpp.Pointer p)

Method Detail

externalizedDataBuffer

public static OpaqueDataBuffer externalizedDataBuffer(long numElements,
                                                      @NonNull
                                                      @NonNull DataType dataType,
                                                      org.bytedeco.javacpp.Pointer primary,
                                                      org.bytedeco.javacpp.Pointer special)

allocateDataBuffer

public static OpaqueDataBuffer allocateDataBuffer(long numElements,
                                                  @NonNull
                                                  @NonNull DataType dataType,
                                                  boolean allocateBoth)

This method allocates new InteropDataBuffer and returns pointer to it

Parameters:

numElements -

dataType -

allocateBoth -

Returns:

expand

public void expand(long numElements)

This method expands buffer, and copies content to the new buffer PLEASE NOTE: if InteropDataBuffer doesn't own actual buffers - original pointers won't be released

Parameters:

numElements -

createView

public OpaqueDataBuffer createView(long bytesLength,
                                   long bytesOffset)

This method creates a view out of this InteropDataBuffer

Parameters:

bytesLength -

bytesOffset -

Returns:

primaryBuffer

public org.bytedeco.javacpp.Pointer primaryBuffer()

This method returns pointer to linear buffer, primary one.

Returns:

specialBuffer

public org.bytedeco.javacpp.Pointer specialBuffer()

This method returns pointer to special buffer, device one, if any.

Returns:

deviceId

public int deviceId()

This method returns deviceId of this DataBuffer

Returns:

setPrimaryBuffer

public void setPrimaryBuffer(org.bytedeco.javacpp.Pointer ptr,
                             long numElements)

This method allows to set external pointer as primary buffer. PLEASE NOTE: if InteropDataBuffer owns current memory buffer, it will be released

Parameters:

ptr -

numElements -

setSpecialBuffer

public void setSpecialBuffer(org.bytedeco.javacpp.Pointer ptr,
                             long numElements)

This method allows to set external pointer as primary buffer. PLEASE NOTE: if InteropDataBuffer owns current memory buffer, it will be released

Parameters:

ptr -

numElements -

syncToSpecial

public void syncToSpecial()

This method synchronizes device memory

syncToPrimary

public void syncToPrimary()

This method synchronizes host memory

closeBuffer

public void closeBuffer()

This method releases underlying buffer