edu.rit.gpu

Class Gpu

java.lang.Object

edu.rit.gpu.Gpu

public class Gpu
extends java.lang.Object

Class Gpu encapsulates a graphics processing unit (GPU) compute device. A GPU compute device, or just "device", is denoted by an integer device number. To use a device:

1. Call the gpu() method to get a Gpu object.

2. Call methods on the Gpu object to perform GPU operations; such as:

3. Informational operations —
   • ensureComputeCapability()
   • getDeviceNumber()
   • getDeviceName()
   • getMultiprocessorCount()

4. GPU configuration —
   • setCacheConfig(), getCacheConfig()
   • setThreadStackSize(), getThreadStackSize()
   • setPrintfFifoSize(), getPrintfFifoSize()
   • setMallocHeapSize(), getMallocHeapSize()

5. Create a dynamically allocated primitive array or matrix in GPU memory —
   • getByteArray(), getByteMatrix()
   • getShortArray(), getShortMatrix()
   • getIntArray(), getIntMatrix()
   • getLongArray(), getLongMatrix()
   • getFloatArray(), getFloatMatrix()
   • getDoubleArray(), getDoubleMatrix()

6. Create a dynamically allocated struct, struct array, or struct matrix in GPU memory —
   • getStructVbl()
   • getStructArray()
   • getStructMatrix()

7. Get a module containing GPU kernel functions and data —
   • getModule()

Study the source code of the classes in package edu.rit.pj2.example to see examples of Parallel Java 2 GPU programs.

Note: Class Gpu is not multiple thread safe. It is assumed that only one thread at a time will call methods on a Gpu object.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	debug Debug flag.

Method Summary

Methods

Modifier and Type	Method and Description
static int	allowedDeviceCount() Get the number of GPU devices this process is allowed to use.
static int	deviceCount() Get the number of GPU devices in the system.
void	ensureComputeCapability(int major, int minor) Ensure that this Gpu object supports at least the given compute capability.
protected void	finalize() Finalize this Gpu object.
GpuByteArray	getByteArray(int len) Create a new dynamically allocated GPU byte array.
GpuByteArray	getByteArray(int len, int cpulen) Create a new dynamically allocated GPU byte array, of which the given portion is mirrored in the CPU.
GpuByteMatrix	getByteMatrix(int rows, int cols) Create a new dynamically allocated GPU byte matrix.
GpuByteMatrix	getByteMatrix(int rows, int cols, int cpurows, int cpucols) Create a new dynamically allocated GPU byte matrix, of which the given portion is mirrored in the CPU.
CacheConfig	getCacheConfig() Get this GPU's cache configuration.
java.lang.String	getDeviceName() Get the device name of this GPU.
int	getDeviceNumber() Get the device number of this GPU.
GpuDoubleArray	getDoubleArray(int len) Create a new dynamically allocated GPU double array.
GpuDoubleArray	getDoubleArray(int len, int cpulen) Create a new dynamically allocated GPU double array, of which the given portion is mirrored in the CPU.
GpuDoubleMatrix	getDoubleMatrix(int rows, int cols) Create a new dynamically allocated GPU double matrix.
GpuDoubleMatrix	getDoubleMatrix(int rows, int cols, int cpurows, int cpucols) Create a new dynamically allocated GPU double matrix, of which the given portion is mirrored in the CPU.
GpuFloatArray	getFloatArray(int len) Create a new dynamically allocated GPU float array.
GpuFloatArray	getFloatArray(int len, int cpulen) Create a new dynamically allocated GPU float array, of which the given portion is mirrored in the CPU.
GpuFloatMatrix	getFloatMatrix(int rows, int cols) Create a new dynamically allocated GPU float matrix.
GpuFloatMatrix	getFloatMatrix(int rows, int cols, int cpurows, int cpucols) Create a new dynamically allocated GPU float matrix, of which the given portion is mirrored in the CPU.
GpuIntArray	getIntArray(int len) Create a new dynamically allocated GPU integer array.
GpuIntArray	getIntArray(int len, int cpulen) Create a new dynamically allocated GPU integer array, of which the given portion is mirrored in the CPU.
GpuIntMatrix	getIntMatrix(int rows, int cols) Create a new dynamically allocated GPU integer matrix.
GpuIntMatrix	getIntMatrix(int rows, int cols, int cpurows, int cpucols) Create a new dynamically allocated GPU integer matrix, of which the given portion is mirrored in the CPU.
GpuLongArray	getLongArray(int len) Create a new dynamically allocated GPU long integer array.
GpuLongArray	getLongArray(int len, int cpulen) Create a new dynamically allocated GPU long integer array, of which the given portion is mirrored in the CPU.
GpuLongMatrix	getLongMatrix(int rows, int cols) Create a new dynamically allocated GPU long integer matrix.
GpuLongMatrix	getLongMatrix(int rows, int cols, int cpurows, int cpucols) Create a new dynamically allocated GPU long integer matrix, of which the given portion is mirrored in the CPU.
long	getMallocHeapSize() Get this GPU's malloc() heap size limit.
Module	getModule(java.lang.String name) Get a module containing GPU functions and data.
int	getMultiprocessorCount() Get the number of multiprocessors in this GPU.
long	getPrintfFifoSize() Get this GPU's printf() FIFO size limit.
GpuShortArray	getShortArray(int len) Create a new dynamically allocated GPU short integer array.
GpuShortArray	getShortArray(int len, int cpulen) Create a new dynamically allocated GPU short integer array, of which the given portion is mirrored in the CPU.
GpuShortMatrix	getShortMatrix(int rows, int cols) Create a new dynamically allocated GPU short integer matrix.
GpuShortMatrix	getShortMatrix(int rows, int cols, int cpurows, int cpucols) Create a new dynamically allocated GPU short integer matrix, of which the given portion is mirrored in the CPU.
<T extends Struct> GpuStructArray<T>	getStructArray(java.lang.Class<T> type, int len) Create a new dynamically allocated GPU struct array.
<T extends Struct> GpuStructArray<T>	getStructArray(java.lang.Class<T> type, int len, int cpulen) Create a new dynamically allocated GPU struct array, of which the given portion is mirrored in the CPU.
<T extends Struct> GpuStructMatrix<T>	getStructMatrix(java.lang.Class<T> type, int rows, int cols) Create a new dynamically allocated GPU struct matrix.
<T extends Struct> GpuStructMatrix<T>	getStructMatrix(java.lang.Class<T> type, int rows, int cols, int cpurows, int cpucols) Create a new dynamically allocated GPU struct matrix, of which the given portion is mirrored in the CPU.
<T extends Struct> GpuStructVbl<T>	getStructVbl(java.lang.Class<T> type) Create a new dynamically allocated GPU struct variable.
long	getThreadStackSize() Get this GPU's thread stack size limit.
static Gpu	gpu() Construct a new Gpu object.
static Gpu	gpu(CtxSched ctxSched) Construct a new Gpu object.
void	setCacheConfig(CacheConfig config) Set this GPU's cache configuration.
static void	setDeviceNumbers(int[] devnum) Specify the GPU device number or numbers this process is allowed to use.
void	setMallocHeapSize(long value) Set this GPU's malloc() heap size limit.
void	setPrintfFifoSize(long value) Set this GPU's printf() FIFO size limit.
void	setThreadStackSize(long value) Set this GPU's thread stack size limit.
java.lang.String	toString() Returns a string version of this Gpu object.

Methods inherited from class java.lang.Object

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

Field Detail

debug

public static boolean debug

Debug flag. If true, when a Gpu object is created, information about the device is printed on the standard error. Default false.

Method Detail

deviceCount

public static int deviceCount()

Get the number of GPU devices in the system.

Returns:

Number of GPU devices.

Throws:

GpuException - (unchecked exception) Thrown if a GPU error occurred.

setDeviceNumbers

public static void setDeviceNumbers(int[] devnum)

Specify the GPU device number or numbers this process is allowed to use. If not specified, this process is allowed to use all devices.

Warning: The setDeviceNumbers() method is intended to be called only by the pj2 launcher program. Do not call the setDeviceNumbers() method yourself.

Parameters:

devnum - Array of zero or more device numbers. Each must be in the range 0 through deviceCount()−1. If devnum is null, this process is allowed to use all devices. If devnum is zero length, this process is not allowed to use any devices.

Throws:

java.lang.IndexOutOfBoundsException - (unchecked exception) Thrown if any device number is out of bounds.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

allowedDeviceCount

public static int allowedDeviceCount()

Get the number of GPU devices this process is allowed to use.

Returns:

Number of GPU devices.

Throws:

GpuException - (unchecked exception) Thrown if a GPU error occurred.

gpu

public static Gpu gpu()

Construct a new Gpu object. The next available GPU device is used. A context scheduling flag of CU_CTX_SCHED_BLOCKING_SYNC is used.

Returns:

Gpu object.

Throws:

java.lang.IllegalStateException - (unchecked exception) Thrown if there are no available GPU devices.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

gpu

public static Gpu gpu(CtxSched ctxSched)

Construct a new Gpu object. The next available GPU device is used. The given context scheduling flag is used.

Parameters:

ctxSched - Context scheduling flag.

Returns:

Gpu object.

Throws:

java.lang.IllegalStateException - (unchecked exception) Thrown if there are no available GPU devices.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

CtxSched

ensureComputeCapability

public void ensureComputeCapability(int major,
                           int minor)

Ensure that this Gpu object supports at least the given compute capability. If so, this method merely returns. If not, this method throws a GpuException.

Parameters:

major - Required compute capability major version.

minor - Required compute capability minor version.

Throws:

GpuException - (unchecked exception) Thrown if this Gpu object does not support at least the given compute capability. Thrown if a GPU error occurred.

getDeviceNumber

public int getDeviceNumber()

Get the device number of this GPU.

Returns:

Device number (GPU ID).

getDeviceName

public java.lang.String getDeviceName()

Get the device name of this GPU.

Returns:

Device name.

getMultiprocessorCount

public int getMultiprocessorCount()

Get the number of multiprocessors in this GPU.

Returns:

Number of multiprocessors.

setCacheConfig

public void setCacheConfig(CacheConfig config)

Set this GPU's cache configuration. All kernel functions that do not themselves set the cache configuration will use the given cache configuration.

Parameters:

config - Cache configuration.

Throws:

java.lang.NullPointerException - (unchecked exception) Thrown if config is null.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

getCacheConfig

public CacheConfig getCacheConfig()

Get this GPU's cache configuration. All kernel functions that do not themselves set the cache configuration will use the returned cache configuration.

Returns:

Cache configuration.

Throws:

GpuException - (unchecked exception) Thrown if a GPU error occurred.

setThreadStackSize

public void setThreadStackSize(long value)

Set this GPU's thread stack size limit.

Parameters:

value - Thread stack size limit.

Throws:

GpuException - (unchecked exception) Thrown if a GPU error occurred.

getThreadStackSize

public long getThreadStackSize()

Get this GPU's thread stack size limit.

Returns:

Thread stack size limit.

Throws:

GpuException - (unchecked exception) Thrown if a GPU error occurred.

setPrintfFifoSize

public void setPrintfFifoSize(long value)

Set this GPU's printf() FIFO size limit.

Parameters:

value - printf() FIFO size limit.

Throws:

GpuException - (unchecked exception) Thrown if a GPU error occurred.

getPrintfFifoSize

public long getPrintfFifoSize()

Get this GPU's printf() FIFO size limit.

Returns:

printf() FIFO size limit.

Throws:

GpuException - (unchecked exception) Thrown if a GPU error occurred.

setMallocHeapSize

public void setMallocHeapSize(long value)

Set this GPU's malloc() heap size limit.

Parameters:

value - malloc() heap size limit.

Throws:

GpuException - (unchecked exception) Thrown if a GPU error occurred.

getMallocHeapSize

public long getMallocHeapSize()

Get this GPU's malloc() heap size limit.

Returns:

malloc() heap size limit.

Throws:

GpuException - (unchecked exception) Thrown if a GPU error occurred.

getByteArray

public GpuByteArray getByteArray(int len)

Create a new dynamically allocated GPU byte array. The entire GPU array is mirrored in the CPU. The array elements in CPU memory, namely the item field's elements, are initialized to zeroes. The array elements in GPU memory are not initialized.

Parameters:

len - Number of array elements (≥ 1).

Returns:

GPU byte array.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if len < 1.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getByteArray(int,int)

getByteArray

public GpuByteArray getByteArray(int len,
                        int cpulen)

Create a new dynamically allocated GPU byte array, of which the given portion is mirrored in the CPU. If cpulen = 0, then none of the array is mirrored in the CPU. The array elements in CPU memory, namely the item field's elements, are initialized to zeroes. The array elements in GPU memory are not initialized.

Parameters:

len - Number of array elements (≥ 1).

cpulen - Number of array elements to mirror in the CPU.

Returns:

GPU byte array.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if len < 1, cpulen < 0, or cpulen > len.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getByteArray(int)

getShortArray

public GpuShortArray getShortArray(int len)

Create a new dynamically allocated GPU short integer array. The entire GPU array is mirrored in the CPU. The array elements in CPU memory, namely the item field's elements, are initialized to zeroes. The array elements in GPU memory are not initialized.

Parameters:

len - Number of array elements (≥ 1).

Returns:

GPU short integer array.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if len < 1.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getShortArray(int,int)

getShortArray

public GpuShortArray getShortArray(int len,
                          int cpulen)

Create a new dynamically allocated GPU short integer array, of which the given portion is mirrored in the CPU. If cpulen = 0, then none of the array is mirrored in the CPU. The array elements in CPU memory, namely the item field's elements, are initialized to zeroes. The array elements in GPU memory are not initialized.

Parameters:

len - Number of array elements (≥ 1).

cpulen - Number of array elements to mirror in the CPU.

Returns:

GPU short integer array.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if len < 1, cpulen < 0, or cpulen > len.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getShortArray(int)

getIntArray

public GpuIntArray getIntArray(int len)

Create a new dynamically allocated GPU integer array. The entire GPU array is mirrored in the CPU. The array elements in CPU memory, namely the item field's elements, are initialized to zeroes. The array elements in GPU memory are not initialized.

Parameters:

len - Number of array elements (≥ 1).

Returns:

GPU integer array.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if len < 1.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getIntArray(int,int)

getIntArray

public GpuIntArray getIntArray(int len,
                      int cpulen)

Create a new dynamically allocated GPU integer array, of which the given portion is mirrored in the CPU. If cpulen = 0, then none of the array is mirrored in the CPU. The array elements in CPU memory, namely the item field's elements, are initialized to zeroes. The array elements in GPU memory are not initialized.

Parameters:

len - Number of array elements (≥ 1).

cpulen - Number of array elements to mirror in the CPU.

Returns:

GPU integer array.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if len < 1, cpulen < 0, or cpulen > len.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getIntArray(int)

getLongArray

public GpuLongArray getLongArray(int len)

Create a new dynamically allocated GPU long integer array. The entire GPU array is mirrored in the CPU. The array elements in CPU memory, namely the item field's elements, are initialized to zeroes. The array elements in GPU memory are not initialized.

Parameters:

len - Number of array elements (≥ 1).

Returns:

GPU long integer array.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if len < 1.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getLongArray(int,int)

getLongArray

public GpuLongArray getLongArray(int len,
                        int cpulen)

Create a new dynamically allocated GPU long integer array, of which the given portion is mirrored in the CPU. If cpulen = 0, then none of the array is mirrored in the CPU. The array elements in CPU memory, namely the item field's elements, are initialized to zeroes. The array elements in GPU memory are not initialized.

Parameters:

len - Number of array elements (≥ 1).

cpulen - Number of array elements to mirror in the CPU.

Returns:

GPU long integer array.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if len < 1, cpulen < 0, or cpulen > len.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getLongArray(int)

getFloatArray

public GpuFloatArray getFloatArray(int len)

Create a new dynamically allocated GPU float array. The entire GPU array is mirrored in the CPU. The array elements in CPU memory, namely the item field's elements, are initialized to zeroes. The array elements in GPU memory are not initialized.

Parameters:

len - Number of array elements (≥ 1).

Returns:

GPU float array.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if len < 1.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getFloatArray(int,int)

getFloatArray

public GpuFloatArray getFloatArray(int len,
                          int cpulen)

Create a new dynamically allocated GPU float array, of which the given portion is mirrored in the CPU. If cpulen = 0, then none of the array is mirrored in the CPU. The array elements in CPU memory, namely the item field's elements, are initialized to zeroes. The array elements in GPU memory are not initialized.

Parameters:

len - Number of array elements (≥ 1).

cpulen - Number of array elements to mirror in the CPU.

Returns:

GPU float array.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if len < 1, cpulen < 0, or cpulen > len.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getFloatArray(int)

getDoubleArray

public GpuDoubleArray getDoubleArray(int len)

Create a new dynamically allocated GPU double array. The entire GPU array is mirrored in the CPU. The array elements in CPU memory, namely the item field's elements, are initialized to zeroes. The array elements in GPU memory are not initialized.

Parameters:

len - Number of array elements (≥ 1).

Returns:

GPU double array.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if len < 1.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getDoubleArray(int,int)

getDoubleArray

public GpuDoubleArray getDoubleArray(int len,
                            int cpulen)

Create a new dynamically allocated GPU double array, of which the given portion is mirrored in the CPU. If cpulen = 0, then none of the array is mirrored in the CPU. The array elements in CPU memory, namely the item field's elements, are initialized to zeroes. The array elements in GPU memory are not initialized.

Parameters:

len - Number of array elements (≥ 1).

cpulen - Number of array elements to mirror in the CPU.

Returns:

GPU double array.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if len < 1, cpulen < 0, or cpulen > len.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getDoubleArray(int)

getByteMatrix

public GpuByteMatrix getByteMatrix(int rows,
                          int cols)

Create a new dynamically allocated GPU byte matrix. The entire GPU matrix is mirrored in the CPU. The matrix elements in CPU memory, namely the item field's elements, are initialized to zeroes. The matrix elements in GPU memory are not initialized.

Parameters:

rows - Number of matrix rows (≥ 1).

cols - Number of matrix columns (≥ 1).

Returns:

GPU byte matrix.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if rows < 1 or cols < 1.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getByteMatrix(int,int,int,int)

getByteMatrix

public GpuByteMatrix getByteMatrix(int rows,
                          int cols,
                          int cpurows,
                          int cpucols)

Create a new dynamically allocated GPU byte matrix, of which the given portion is mirrored in the CPU. If cpurows = 0 or cpucols = 0, then none of the matrix is mirrored in the CPU. The matrix elements in CPU memory, namely the item field's elements, are initialized to zeroes. The matrix elements in GPU memory are not initialized.

Parameters:

rows - Number of matrix rows (≥ 1).

cols - Number of matrix columns (≥ 1).

cpurows - Number of matrix rows to mirror in the CPU.

cpucols - Number of matrix columns to mirror in the CPU.

Returns:

GPU byte matrix.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if rows < 1, cols < 1, cpurows < 0, cpurows > rows, cpucols < 0, or cpucols > cols.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getByteMatrix(int,int)

getShortMatrix

public GpuShortMatrix getShortMatrix(int rows,
                            int cols)

Create a new dynamically allocated GPU short integer matrix. The entire GPU matrix is mirrored in the CPU. The matrix elements in CPU memory, namely the item field's elements, are initialized to zeroes. The matrix elements in GPU memory are not initialized.

Parameters:

rows - Number of matrix rows (≥ 1).

cols - Number of matrix columns (≥ 1).

Returns:

GPU short integer matrix.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if rows < 1 or cols < 1.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getShortMatrix(int,int,int,int)

getShortMatrix

public GpuShortMatrix getShortMatrix(int rows,
                            int cols,
                            int cpurows,
                            int cpucols)

Create a new dynamically allocated GPU short integer matrix, of which the given portion is mirrored in the CPU. If cpurows = 0 or cpucols = 0, then none of the matrix is mirrored in the CPU. The matrix elements in CPU memory, namely the item field's elements, are initialized to zeroes. The matrix elements in GPU memory are not initialized.

Parameters:

rows - Number of matrix rows (≥ 1).

cols - Number of matrix columns (≥ 1).

cpurows - Number of matrix rows to mirror in the CPU.

cpucols - Number of matrix columns to mirror in the CPU.

Returns:

GPU short integer matrix.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if rows < 1, cols < 1, cpurows < 0, cpurows > rows, cpucols < 0, or cpucols > cols.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getShortMatrix(int,int)

getIntMatrix

public GpuIntMatrix getIntMatrix(int rows,
                        int cols)

Create a new dynamically allocated GPU integer matrix. The entire GPU matrix is mirrored in the CPU. The matrix elements in CPU memory, namely the item field's elements, are initialized to zeroes. The matrix elements in GPU memory are not initialized.

Parameters:

rows - Number of matrix rows (≥ 1).

cols - Number of matrix columns (≥ 1).

Returns:

GPU integer matrix.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if rows < 1 or cols < 1.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getIntMatrix(int,int,int,int)

getIntMatrix

public GpuIntMatrix getIntMatrix(int rows,
                        int cols,
                        int cpurows,
                        int cpucols)

Create a new dynamically allocated GPU integer matrix, of which the given portion is mirrored in the CPU. If cpurows = 0 or cpucols = 0, then none of the matrix is mirrored in the CPU. The matrix elements in CPU memory, namely the item field's elements, are initialized to zeroes. The matrix elements in GPU memory are not initialized.

Parameters:

rows - Number of matrix rows (≥ 1).

cols - Number of matrix columns (≥ 1).

cpurows - Number of matrix rows to mirror in the CPU.

cpucols - Number of matrix columns to mirror in the CPU.

Returns:

GPU integer matrix.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if rows < 1, cols < 1, cpurows < 0, cpurows > rows, cpucols < 0, or cpucols > cols.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getIntMatrix(int,int)

getLongMatrix

public GpuLongMatrix getLongMatrix(int rows,
                          int cols)

Create a new dynamically allocated GPU long integer matrix. The entire GPU matrix is mirrored in the CPU. The matrix elements in CPU memory, namely the item field's elements, are initialized to zeroes. The matrix elements in GPU memory are not initialized.

Parameters:

rows - Number of matrix rows (≥ 1).

cols - Number of matrix columns (≥ 1).

Returns:

GPU long integer matrix.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if rows < 1 or cols < 1.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getLongMatrix(int,int,int,int)

getLongMatrix

public GpuLongMatrix getLongMatrix(int rows,
                          int cols,
                          int cpurows,
                          int cpucols)

Create a new dynamically allocated GPU long integer matrix, of which the given portion is mirrored in the CPU. If cpurows = 0 or cpucols = 0, then none of the matrix is mirrored in the CPU. The matrix elements in CPU memory, namely the item field's elements, are initialized to zeroes. The matrix elements in GPU memory are not initialized.

Parameters:

rows - Number of matrix rows (≥ 1).

cols - Number of matrix columns (≥ 1).

cpurows - Number of matrix rows to mirror in the CPU.

cpucols - Number of matrix columns to mirror in the CPU.

Returns:

GPU long integer matrix.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if rows < 1, cols < 1, cpurows < 0, cpurows > rows, cpucols < 0, or cpucols > cols.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getLongMatrix(int,int)

getFloatMatrix

public GpuFloatMatrix getFloatMatrix(int rows,
                            int cols)

Create a new dynamically allocated GPU float matrix. The entire GPU matrix is mirrored in the CPU. The matrix elements in CPU memory, namely the item field's elements, are initialized to zeroes. The matrix elements in GPU memory are not initialized.

Parameters:

rows - Number of matrix rows (≥ 1).

cols - Number of matrix columns (≥ 1).

Returns:

GPU float matrix.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if rows < 1 or cols < 1.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getFloatMatrix(int,int,int,int)

getFloatMatrix

public GpuFloatMatrix getFloatMatrix(int rows,
                            int cols,
                            int cpurows,
                            int cpucols)

Create a new dynamically allocated GPU float matrix, of which the given portion is mirrored in the CPU. If cpurows = 0 or cpucols = 0, then none of the matrix is mirrored in the CPU. The matrix elements in CPU memory, namely the item field's elements, are initialized to zeroes. The matrix elements in GPU memory are not initialized.

Parameters:

rows - Number of matrix rows (≥ 1).

cols - Number of matrix columns (≥ 1).

cpurows - Number of matrix rows to mirror in the CPU.

cpucols - Number of matrix columns to mirror in the CPU.

Returns:

GPU float matrix.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if rows < 1, cols < 1, cpurows < 0, cpurows > rows, cpucols < 0, or cpucols > cols.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getFloatMatrix(int,int)

getDoubleMatrix

public GpuDoubleMatrix getDoubleMatrix(int rows,
                              int cols)

Create a new dynamically allocated GPU double matrix. The entire GPU matrix is mirrored in the CPU. The matrix elements in CPU memory, namely the item field's elements, are initialized to zeroes. The matrix elements in GPU memory are not initialized.

Parameters:

rows - Number of matrix rows (≥ 1).

cols - Number of matrix columns (≥ 1).

Returns:

GPU double matrix.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if rows < 1 or cols < 1.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getDoubleMatrix(int,int,int,int)

getDoubleMatrix

public GpuDoubleMatrix getDoubleMatrix(int rows,
                              int cols,
                              int cpurows,
                              int cpucols)

Create a new dynamically allocated GPU double matrix, of which the given portion is mirrored in the CPU. If cpurows = 0 or cpucols = 0, then none of the matrix is mirrored in the CPU. The matrix elements in CPU memory, namely the item field's elements, are initialized to zeroes. The matrix elements in GPU memory are not initialized.

Parameters:

rows - Number of matrix rows (≥ 1).

cols - Number of matrix columns (≥ 1).

cpurows - Number of matrix rows to mirror in the CPU.

cpucols - Number of matrix columns to mirror in the CPU.

Returns:

GPU double matrix.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if rows < 1, cols < 1, cpurows < 0, cpurows > rows, cpucols < 0, or cpucols > cols.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getDoubleMatrix(int,int)

getStructVbl

public <T extends Struct> GpuStructVbl<T> getStructVbl(java.lang.Class<T> type)

Create a new dynamically allocated GPU struct variable. The variable in CPU memory, namely the item field, is initialized to null. The variable in GPU memory is not initialized.

Type Parameters:

T - Java data type. Class T must extend class Struct.

Parameters:

type - Class object for Java data type.

Returns:

GPU struct variable.

Throws:

java.lang.NullPointerException - (unchecked exception) Thrown if type is null.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

getStructArray

public <T extends Struct> GpuStructArray<T> getStructArray(java.lang.Class<T> type,
                                                  int len)

Create a new dynamically allocated GPU struct array. The entire GPU array is mirrored in the CPU. The array elements in CPU memory, namely the item field's elements, are initialized to null. The array elements in GPU memory are not initialized.

Type Parameters:

T - Java data type. Class T must extend class Struct.

Parameters:

type - Class object for Java data type.

len - Number of array elements (≥ 1).

Returns:

GPU struct array.

Throws:

java.lang.NullPointerException - (unchecked exception) Thrown if type is null.

java.lang.IllegalArgumentException - (unchecked exception) Thrown if len < 1.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getStructArray(Class,int,int)

getStructArray

public <T extends Struct> GpuStructArray<T> getStructArray(java.lang.Class<T> type,
                                                  int len,
                                                  int cpulen)

Create a new dynamically allocated GPU struct array, of which the given portion is mirrored in the CPU. If cpulen = 0, then none of the array is mirrored in the CPU. The array elements in CPU memory, namely the item field's elements, are initialized to null. The array elements in GPU memory are not initialized.

Type Parameters:

T - Java data type. Class T must extend class Struct.

Parameters:

type - Class object for Java data type.

len - Number of array elements (≥ 1).

cpulen - Number of array elements to mirror in the CPU.

Returns:

GPU struct array.

Throws:

java.lang.NullPointerException - (unchecked exception) Thrown if type is null.

java.lang.IllegalArgumentException - (unchecked exception) Thrown if len < 1, cpulen < 0, or cpulen > len.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getStructArray(Class,int)

getStructMatrix

public <T extends Struct> GpuStructMatrix<T> getStructMatrix(java.lang.Class<T> type,
                                                    int rows,
                                                    int cols)

Create a new dynamically allocated GPU struct matrix. The entire GPU matrix is mirrored in the CPU. The matrix elements in CPU memory, namely the item field's elements, are initialized to null. The matrix elements in GPU memory are not initialized.

Type Parameters:

T - Java data type. Class T must extend class Struct.

Parameters:

type - Class object for Java data type.

rows - Number of matrix rows (≥ 1).

cols - Number of matrix columns (≥ 1).

Returns:

GPU struct matrix.

Throws:

java.lang.NullPointerException - (unchecked exception) Thrown if type is null.

java.lang.IllegalArgumentException - (unchecked exception) Thrown if rows < 1 or cols < 1.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getStructMatrix(Class,int,int,int,int)

getStructMatrix

public <T extends Struct> GpuStructMatrix<T> getStructMatrix(java.lang.Class<T> type,
                                                    int rows,
                                                    int cols,
                                                    int cpurows,
                                                    int cpucols)

Create a new dynamically allocated GPU struct matrix, of which the given portion is mirrored in the CPU. If cpurows = 0 or cpucols = 0, then none of the matrix is mirrored in the CPU. The matrix elements in CPU memory, namely the item field's elements, are initialized to null. The matrix elements in GPU memory are not initialized.

Type Parameters:

T - Java data type. Class T must extend class Struct.

Parameters:

type - Class object for Java data type.

rows - Number of matrix rows (≥ 1).

cols - Number of matrix columns (≥ 1).

cpurows - Number of matrix rows to mirror in the CPU.

cpucols - Number of matrix columns to mirror in the CPU.

Returns:

GPU struct matrix.

Throws:

java.lang.NullPointerException - (unchecked exception) Thrown if type is null.

java.lang.IllegalArgumentException - (unchecked exception) Thrown if rows < 1, cols < 1, cpurows < 0, cpurows > rows, cpucols < 0, or cpucols > cols.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

See Also:

getStructMatrix(Class,int,int)

getModule

public Module getModule(java.lang.String name)
                 throws java.io.IOException

Get a module containing GPU functions and data. The module file is a resource stored in the Java class path.

Parameters:

name - Module resource name relative to the Java class path.

Throws:

java.io.IOException - Thrown if an I/O error occurred.

GpuException - (unchecked exception) Thrown if a GPU error occurred.

toString

public java.lang.String toString()

Returns a string version of this Gpu object.

Overrides:

toString in class java.lang.Object

Returns:

String version.

finalize

protected void finalize()

Finalize this Gpu object.

Overrides:

finalize in class java.lang.Object