org.nd4j.linalg.jcublas.buffer

Interface JCudaBuffer

All Superinterfaces:

DataBuffer, Serializable

All Known Implementing Classes:

BaseCudaDataBuffer, CudaDoubleDataBuffer, CudaFloatDataBuffer, CudaIntDataBuffer

public interface JCudaBuffer
extends DataBuffer

A Jcuda buffer

Author:

Adam Gibson

Nested Class Summary

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

DataBuffer.AllocationMode, DataBuffer.Type

Method Summary

Modifier and Type	Method and Description
boolean	copied(String name) Returns true if the buffer has already been copied to the device
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
boolean	freeDevicePointer(int offset, int length) Frees the pointer
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
Buffer	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	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)

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

addReferencing, allocationMode, array, asBytes, asDouble, asFloat, asInt, asNetty, asNio, asNioDouble, asNioFloat, assign, assign, assign, assign, assign, assign, assign, assign, assign, assign, copyAtStride, dataType, destroy, dirty, dup, flush, getComplex, getComplexDouble, getComplexFloat, getDouble, getDoublesAt, getDoublesAt, getElementSize, getFloat, getFloatsAt, getFloatsAt, getInt, getNumber, isPersist, length, persist, put, put, put, put, read, references, removeReferencing, setData, setData, setData, unPersist, write

Method Detail

setHostBuffer

void setHostBuffer(ByteBuffer hostBuffer)

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

Parameters:

hostBuffer -

getHostBuffer

Buffer getHostBuffer()

Get the underlying host bytebuffer

Returns:

getHostPointer

Pointer getHostPointer()

THe pointer for the buffer

Returns:

the pointer for this buffer

getHostPointer

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

Parameters:

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

Returns:

the pointer at the given byte offset

getDevicePointer

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

Get the device pointer with the given offset and stride

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

getDevicePointer

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

Get the device pointer with the given offset and stride

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

set

void set(Pointer pointer)

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

Parameters:

pointer - the pointer to set

freeDevicePointer

boolean freeDevicePointer(int offset,
                          int length)

Frees the pointer

Parameters:

offset - the offset to free

length - the length to free

Returns:

true if the pointer was freed, false other wise

copyToHost

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

Copy to the host synchronizing using the given context

Parameters:

context - the context to synchronize

offset - the offset to copy

length - the length to copy

copyToHost

void copyToHost(int offset,
                int length)

Copies the buffer to the host

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)

getPointersToContexts

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

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

Returns:

the pointer info containing allocated pointers

copied

boolean copied(String name)

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

Returns:

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

setCopied

void setCopied(String name)

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

Parameters:

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