org.nd4j.linalg.jcublas.buffer

Class BaseCudaDataBuffer

java.lang.Object

org.nd4j.linalg.api.buffer.BaseDataBuffer

org.nd4j.linalg.jcublas.buffer.BaseCudaDataBuffer

All Implemented Interfaces:

Serializable, DataBuffer, JCudaBuffer

Direct Known Subclasses:

CudaDoubleDataBuffer, CudaFloatDataBuffer, CudaIntDataBuffer

public abstract class BaseCudaDataBuffer
extends BaseDataBuffer
implements JCudaBuffer

Base class for a data buffer

Author:

Adam Gibson

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.nd4j.linalg.api.buffer.DataBuffer

DataBuffer.AllocationMode, DataBuffer.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicBoolean	freed
protected AtomicBoolean	modified
protected com.google.common.collect.Table<String,org.apache.commons.lang3.tuple.Triple<Integer,Integer,Integer>,DevicePointerInfo>	pointersToContexts Pointers to contexts covers this buffer on the gpu at offset 0 for each thread.
protected WeakReference<DataBuffer>	ref
protected Collection<String>	referencing

Fields inherited from class org.nd4j.linalg.api.buffer.BaseDataBuffer

allocationMode, dataBuffer, dirty, doubleData, elementSize, floatData, intData, isPersist, length

Constructor Summary

Constructors

Constructor and Description
BaseCudaDataBuffer(byte[] data, int length)
BaseCudaDataBuffer(io.netty.buffer.ByteBuf buf, int length)
BaseCudaDataBuffer(double[] data)
BaseCudaDataBuffer(double[] data, boolean copy)
BaseCudaDataBuffer(float[] data)
BaseCudaDataBuffer(float[] data, boolean copy)
BaseCudaDataBuffer(int length)
BaseCudaDataBuffer(int[] data)
BaseCudaDataBuffer(int[] data, boolean copy)
BaseCudaDataBuffer(int length, int elementSize) Base constructor

Method Summary

Modifier and Type	Method and Description
void	addReferencing(String id)
DataBuffer.AllocationMode	allocationMode()
void	assign(DataBuffer data)
boolean	copied(String name) Returns true if the buffer has already been copied to the device
void	copyAtStride(DataBuffer buf, int n, int stride, int yStride, int offset, int yOffset)
void	copyToHost(CudaContext context, int offset, int length) Copy to the host synchronizing using the given context
void	copyToHost(int offset, int length) Copies the buffer to the host
void	destroy()
void	flush()
boolean	freeDevicePointer(int offset, int length) Frees the pointer
IComplexNumber	getComplex(int i)
IComplexDouble	getComplexDouble(int i)
IComplexFloat	getComplexFloat(int i)
Pointer	getDevicePointer(INDArray arr, int stride, int offset, int length) Get the device pointer with the given offset and stride
Pointer	getDevicePointer(int stride, int offset, int length) Get the device pointer with the given offset and stride
int	getElementSize()
ByteBuffer	getHostBuffer() Get the underlying host bytebuffer
Pointer	getHostPointer() THe pointer for the buffer
Pointer	getHostPointer(int offset) Get the host pointer with the given offset note that this will automatically multiply the specified offset by the element size
com.google.common.collect.Table<String,org.apache.commons.lang3.tuple.Triple<Integer,Integer,Integer>,DevicePointerInfo>	getPointersToContexts() Pointer to context map.
void	put(int i, double element)
void	put(int i, float element)
void	put(int i, IComplexNumber result)
Collection<String>	references()
void	removeReferencing(String id)
protected void	set(int index, int length, Pointer from) Set an individual element
protected void	set(int index, int length, Pointer from, int inc) Set an individual element
protected void	set(int index, Pointer from) Set an individual element
void	set(Pointer pointer) Sets the data for this pointer from the data in this pointer
void	setCopied(String name) Returns true if the data for this thread name has already been copied
void	setHostBuffer(ByteBuffer hostBuffer) Set the underlying host buffer, very fast method of copying on RAM side and not using cublas (SLOW)
void	setPointersToContexts(com.google.common.collect.Table<String,org.apache.commons.lang3.tuple.Triple<Integer,Integer,Integer>,DevicePointerInfo> pointersToContexts)
String	toString()

Methods inherited from class org.nd4j.linalg.api.buffer.BaseDataBuffer

array, asBytes, asDouble, asFloat, asInt, asNetty, asNio, asNioDouble, asNioFloat, assign, assign, assign, assign, assign, assign, assign, assign, assign, create, create, create, create, create, dirty, doReadObject, dup, ensureWritable, equals, getDouble, getDoublesAt, getDoublesAt, getFloat, getFloatsAt, getFloatsAt, getInt, getNumber, hashCode, isPersist, length, persist, put, read, read, setData, setData, setData, unPersist, write, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.nd4j.linalg.api.buffer.DataBuffer

array, asBytes, asDouble, asFloat, asInt, asNetty, asNio, asNioDouble, asNioFloat, assign, assign, assign, assign, assign, assign, assign, assign, assign, dataType, dirty, dup, getDouble, getDoublesAt, getDoublesAt, getFloat, getFloatsAt, getFloatsAt, getInt, getNumber, isPersist, length, persist, put, read, setData, setData, setData, unPersist, write

Field Detail

pointersToContexts

protected transient com.google.common.collect.Table<String,org.apache.commons.lang3.tuple.Triple<Integer,Integer,Integer>,DevicePointerInfo> pointersToContexts

Pointers to contexts covers this buffer on the gpu at offset 0 for each thread. The column key is for offsets. If we only have buffer one device allocation per thread we will clobber anything that is already allocated on the gpu. This also allows us to make a simplifying assumption about how to allocate the data as follows: Always allocate for offset zero by default. This allows us to reuse the same pointer with an offset for each extra allocations (say for row wise operations) This also prevents duplicate uploads to the gpu.

modified

protected AtomicBoolean modified

referencing

protected Collection<String> referencing

ref

protected transient WeakReference<DataBuffer> ref

freed

protected AtomicBoolean freed

Constructor Detail

BaseCudaDataBuffer

public BaseCudaDataBuffer(io.netty.buffer.ByteBuf buf,
                          int length)

BaseCudaDataBuffer

public BaseCudaDataBuffer(float[] data,
                          boolean copy)

BaseCudaDataBuffer

public BaseCudaDataBuffer(double[] data,
                          boolean copy)

BaseCudaDataBuffer

public BaseCudaDataBuffer(int[] data,
                          boolean copy)

BaseCudaDataBuffer

public BaseCudaDataBuffer(int length,
                          int elementSize)

Base constructor

Parameters:

length - the length of the buffer

elementSize - the size of each element

BaseCudaDataBuffer

public BaseCudaDataBuffer(int length)

BaseCudaDataBuffer

public BaseCudaDataBuffer(float[] data)

BaseCudaDataBuffer

public BaseCudaDataBuffer(int[] data)

BaseCudaDataBuffer

public BaseCudaDataBuffer(double[] data)

BaseCudaDataBuffer

public BaseCudaDataBuffer(byte[] data,
                          int length)

Method Detail

copyAtStride

public void copyAtStride(DataBuffer buf,
                         int n,
                         int stride,
                         int yStride,
                         int offset,
                         int yOffset)

Specified by:

copyAtStride in interface DataBuffer

Overrides:

copyAtStride in class BaseDataBuffer

copied

public boolean copied(String name)

Description copied from interface: JCudaBuffer

Returns true if the buffer has already been copied to the device

Specified by:

copied in interface JCudaBuffer

Returns:

true if the buffer has already been copied to the device false otherwise

setCopied

public void setCopied(String name)

Description copied from interface: JCudaBuffer

Returns true if the data for this thread name has already been copied

Specified by:

setCopied in interface JCudaBuffer

Parameters:

name - the name of the thread to check for whether it's been copied or not

allocationMode

public DataBuffer.AllocationMode allocationMode()

Specified by:

allocationMode in interface DataBuffer

Overrides:

allocationMode in class BaseDataBuffer

getHostBuffer

public ByteBuffer getHostBuffer()

Description copied from interface: JCudaBuffer

Get the underlying host bytebuffer

Specified by:

getHostBuffer in interface JCudaBuffer

Returns:

setHostBuffer

public void setHostBuffer(ByteBuffer hostBuffer)

Description copied from interface: JCudaBuffer

Set the underlying host buffer, very fast method of copying on RAM side and not using cublas (SLOW)

Specified by:

setHostBuffer in interface JCudaBuffer

getHostPointer

public Pointer getHostPointer()

Description copied from interface: JCudaBuffer

THe pointer for the buffer

Specified by:

getHostPointer in interface JCudaBuffer

Returns:

the pointer for this buffer

getHostPointer

public Pointer getHostPointer(int offset)

Description copied from interface: JCudaBuffer

Get the host pointer with the given offset note that this will automatically multiply the specified offset by the element size

Specified by:

getHostPointer in interface JCudaBuffer

Parameters:

offset - the offset (NOT MULTIPLIED BY ELEMENT SIZE) to index in to the pointer at

Returns:

the pointer at the given byte offset

removeReferencing

public void removeReferencing(String id)

Specified by:

removeReferencing in interface DataBuffer

Overrides:

removeReferencing in class BaseDataBuffer

references

public Collection<String> references()

Specified by:

references in interface DataBuffer

Overrides:

references in class BaseDataBuffer

getElementSize

public int getElementSize()

Specified by:

getElementSize in interface DataBuffer

addReferencing

public void addReferencing(String id)

Specified by:

addReferencing in interface DataBuffer

Overrides:

addReferencing in class BaseDataBuffer

put

public void put(int i,
                IComplexNumber result)

Specified by:

put in interface DataBuffer

Overrides:

put in class BaseDataBuffer

getDevicePointer

public Pointer getDevicePointer(int stride,
                                int offset,
                                int length)

Description copied from interface: JCudaBuffer

Get the device pointer with the given offset and stride

Specified by:

getDevicePointer in interface JCudaBuffer

Parameters:

stride - the stride for the device pointer

offset - the offset for the device pointer

length - the length of the pointer

Returns:

the device pointer with the given offset and stride

getDevicePointer

public Pointer getDevicePointer(INDArray arr,
                                int stride,
                                int offset,
                                int length)

Description copied from interface: JCudaBuffer

Get the device pointer with the given offset and stride

Specified by:

getDevicePointer in interface JCudaBuffer

Parameters:

arr - the array to get the device pointer for

stride - the stride for the device pointer

offset - the offset for the device pointer

length - the length of the pointer

Returns:

the device pointer with the given offset and stride

set

public void set(Pointer pointer)

Description copied from interface: JCudaBuffer

Sets the data for this pointer from the data in this pointer

Specified by:

set in interface JCudaBuffer

Parameters:

pointer - the pointer to set

put

public void put(int i,
                float element)

Specified by:

put in interface DataBuffer

Overrides:

put in class BaseDataBuffer

put

public void put(int i,
                double element)

Specified by:

put in interface DataBuffer

Overrides:

put in class BaseDataBuffer

getComplexFloat

public IComplexFloat getComplexFloat(int i)

Specified by:

getComplexFloat in interface DataBuffer

Overrides:

getComplexFloat in class BaseDataBuffer

getComplexDouble

public IComplexDouble getComplexDouble(int i)

Specified by:

getComplexDouble in interface DataBuffer

Overrides:

getComplexDouble in class BaseDataBuffer

getComplex

public IComplexNumber getComplex(int i)

Specified by:

getComplex in interface DataBuffer

Overrides:

getComplex in class BaseDataBuffer

set

protected void set(int index,
                   int length,
                   Pointer from,
                   int inc)

Set an individual element

Parameters:

index - the index of the element

from - the element to get data from

set

protected void set(int index,
                   int length,
                   Pointer from)

Set an individual element

Parameters:

index - the index of the element

from - the element to get data from

assign

public void assign(DataBuffer data)

Specified by:

assign in interface DataBuffer

Overrides:

assign in class BaseDataBuffer

set

protected void set(int index,
                   Pointer from)

Set an individual element

Parameters:

index - the index of the element

from - the element to get data from

freeDevicePointer

public boolean freeDevicePointer(int offset,
                                 int length)

Description copied from interface: JCudaBuffer

Frees the pointer

Specified by:

freeDevicePointer in interface JCudaBuffer

Parameters:

offset - the offset to free

length - the length to free

Returns:

true if the pointer was freed, false other wise

copyToHost

public void copyToHost(CudaContext context,
                       int offset,
                       int length)

Description copied from interface: JCudaBuffer

Copy to the host synchronizing using the given context

Specified by:

copyToHost in interface JCudaBuffer

Parameters:

context - the context to synchronize

offset - the offset to copy

length - the length to copy

copyToHost

public void copyToHost(int offset,
                       int length)

Description copied from interface: JCudaBuffer

Copies the buffer to the host

Specified by:

copyToHost in interface JCudaBuffer

Parameters:

offset - the offset for the buffer (one buffer may have multiple pointers

length - the length of the pointer (one buffer may have different lengths)

flush

public void flush()

Specified by:

flush in interface DataBuffer

Overrides:

flush in class BaseDataBuffer

destroy

public void destroy()

Specified by:

destroy in interface DataBuffer

Overrides:

destroy in class BaseDataBuffer

getPointersToContexts

public com.google.common.collect.Table<String,org.apache.commons.lang3.tuple.Triple<Integer,Integer,Integer>,DevicePointerInfo> getPointersToContexts()

Description copied from interface: JCudaBuffer

Pointer to context map. Contains the device pointer information mapping thread name to offset

Specified by:

getPointersToContexts in interface JCudaBuffer

Returns:

the pointer info containing allocated pointers

setPointersToContexts

public void setPointersToContexts(com.google.common.collect.Table<String,org.apache.commons.lang3.tuple.Triple<Integer,Integer,Integer>,DevicePointerInfo> pointersToContexts)

toString

public String toString()

Overrides:

toString in class BaseDataBuffer