org.nd4j.linalg.api.buffer

Interface DataBuffer

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

BaseDataBuffer, DoubleBuffer, FloatBuffer, IntBuffer

public interface DataBuffer
extends java.io.Serializable

A data buffer is an interface for handling storage and retrieval of data

Author:

Adam Gibson

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DOUBLE
static java.lang.String	FLOAT

Method Summary

Modifier and Type	Method and Description
byte[]	asBytes() Raw byte array storage
double[]	asDouble() Return the buffer as a double array Relative to the datatype, this will either be a copy or a reference.
float[]	asFloat() Return the buffer as a float array Relative to the datatype, this will either be a copy or a reference.
int[]	asInt() Return the buffer as an int array Relative to the datatype, this will either be a copy or a reference.
<E> E[]	asType() Returns the element buffer of the specified type.
java.lang.String	dataType() The data type of the buffer
void	destroy() Clears this buffer
DataBuffer	dup() Return a copy of this buffer
void	flush() Flush the data buffer
double	getDouble(int i) Get element i in the buffer as a double
<E> E	getElement(int i) Get element i in the buffer as a double
float	getFloat(int i) Get element i in the buffer as a double
int	getInt(int ix) Get the int at the specified index
java.lang.Number	getNumber(int i) Get element i in the buffer as a double
int	length() Returns the length of the buffer
void	put(int i, double element) Assign an element in the buffer to the specified index
<E> void	put(int i, E element) Assign an element in the buffer to the specified index
void	put(int i, float element) Assign an element in the buffer to the specified index
void	put(int i, int element) Assign an element in the buffer to the specified index

Field Detail

DOUBLE

static final java.lang.String DOUBLE

See Also:

Constant Field Values

FLOAT

static final java.lang.String FLOAT

See Also:

Constant Field Values

Method Detail

asBytes

byte[] asBytes()

Raw byte array storage

Returns:

the data represented as a raw byte array

dataType

java.lang.String dataType()

The data type of the buffer

Returns:

the data type of the buffer

asFloat

float[] asFloat()

Return the buffer as a float array Relative to the datatype, this will either be a copy or a reference. The reference is preferred for faster access of data and no copying

Returns:

the buffer as a float

asDouble

double[] asDouble()

Return the buffer as a double array Relative to the datatype, this will either be a copy or a reference. The reference is preferred for faster access of data and no copying

Returns:

the buffer as a float

asInt

int[] asInt()

Return the buffer as an int array Relative to the datatype, this will either be a copy or a reference. The reference is preferred for faster access of data and no copying

Returns:

the buffer as a float

asType

<E> E[] asType()

Returns the element buffer of the specified type.

Type Parameters:

E -

Returns:

the element buffer of the specified type

getDouble

double getDouble(int i)

Get element i in the buffer as a double

Parameters:

i - the element to getFloat

Returns:

the element at this index

getFloat

float getFloat(int i)

Get element i in the buffer as a double

Parameters:

i - the element to getFloat

Returns:

the element at this index

getNumber

java.lang.Number getNumber(int i)

Get element i in the buffer as a double

Parameters:

i - the element to getFloat

Returns:

the element at this index

getElement

<E> E getElement(int i)

Get element i in the buffer as a double

Parameters:

i - the element to getFloat

Returns:

the element at this index

put

void put(int i,
         float element)

Assign an element in the buffer to the specified index

Parameters:

i - the index

element - the element to assign

put

void put(int i,
         double element)

Assign an element in the buffer to the specified index

Parameters:

i - the index

element - the element to assign

put

void put(int i,
         int element)

Assign an element in the buffer to the specified index

Parameters:

i - the index

element - the element to assign

put

<E> void put(int i,
             E element)

Assign an element in the buffer to the specified index

Parameters:

i - the index

element - the element to assign

length

int length()

Returns the length of the buffer

Returns:

the length of the buffer

getInt

int getInt(int ix)

Get the int at the specified index

Parameters:

ix - the int at the specified index

Returns:

the int at the specified index

dup

DataBuffer dup()

Return a copy of this buffer

Returns:

a copy of this buffer

flush

void flush()

Flush the data buffer

destroy

void destroy()

Clears this buffer