org.nd4j.linalg.jcublas

Class CublasPointer

java.lang.Object

org.nd4j.linalg.jcublas.CublasPointer

All Implemented Interfaces:

AutoCloseable

public class CublasPointer
extends Object
implements AutoCloseable

Wraps the allocation and freeing of resources on a cuda device

Author:

bam4d

Constructor Summary

Constructors

Constructor and Description
CublasPointer(INDArray array, CudaContext context) Creates a CublasPointer for a given INDArray.
CublasPointer(JCudaBuffer buffer, CudaContext context) Creates a CublasPointer for a given JCudaBuffer

Method Summary

Modifier and Type	Method and Description
void	close() frees the underlying device memory allocated for this pointer
void	copyToHost() copies the result to the host buffer
void	destroy() The actual destroy method
static void	free(CublasPointer... pointers)
JCudaBuffer	getBuffer()
Pointer	getDevicePointer()
boolean	isResultPointer() Whether this is a result pointer or not A result pointer means that this pointer should not automatically be freed but instead wait for results to accumulate so they can be returned from the gpu first
void	setResultPointer(boolean resultPointer) Sets whether this is a result pointer or not A result pointer means that this pointer should not automatically be freed but instead wait for results to accumulate so they can be returned from the gpu first
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CublasPointer

public CublasPointer(JCudaBuffer buffer,
                     CudaContext context)

Creates a CublasPointer for a given JCudaBuffer

Parameters:

buffer -

CublasPointer

public CublasPointer(INDArray array,
                     CudaContext context)

Creates a CublasPointer for a given INDArray. This wrapper makes sure that the INDArray offset, stride and memory pointers are accurate to the data being copied to and from the device. If the copyToHost function is used in in this class, the host buffer offset and data length is taken care of automatically

Parameters:

array -

Method Detail

close

public void close()
           throws Exception

frees the underlying device memory allocated for this pointer

Specified by:

close in interface AutoCloseable

Throws:

Exception

destroy

public void destroy()

The actual destroy method

getBuffer

public JCudaBuffer getBuffer()

Returns:

getDevicePointer

public Pointer getDevicePointer()

Returns:

copyToHost

public void copyToHost()

copies the result to the host buffer

isResultPointer

public boolean isResultPointer()

Whether this is a result pointer or not A result pointer means that this pointer should not automatically be freed but instead wait for results to accumulate so they can be returned from the gpu first

Returns:

setResultPointer

public void setResultPointer(boolean resultPointer)

Sets whether this is a result pointer or not A result pointer means that this pointer should not automatically be freed but instead wait for results to accumulate so they can be returned from the gpu first

toString

public String toString()

Overrides:

toString in class Object

free

public static void free(CublasPointer... pointers)