org.nd4j.linalg.api.buffer

Class BaseDataBuffer

java.lang.Object

org.nd4j.linalg.api.buffer.BaseDataBuffer

All Implemented Interfaces:

Serializable, DataBuffer

Direct Known Subclasses:

DoubleBuffer, FloatBuffer, IntBuffer

public abstract class BaseDataBuffer
extends Object
implements DataBuffer

Base class for a data buffer handling basic byte operations among other things.

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 DataBuffer.AllocationMode	allocationMode
protected AtomicBoolean	dirty
protected double[]	doubleData
protected int	elementSize
protected float[]	floatData
protected int[]	intData
protected boolean	isPersist
protected int	length
protected WeakReference<DataBuffer>	ref
protected Collection<String>	referencing
protected ByteBuffer	wrappedBuffer

Constructor Summary

Constructors

Modifier	Constructor and Description
	BaseDataBuffer(byte[] data, int length)
	BaseDataBuffer(ByteBuffer buffer, int length) Create a data buffer from the given length
protected	BaseDataBuffer(io.netty.buffer.ByteBuf buf, int length)
	BaseDataBuffer(double[] data)
	BaseDataBuffer(double[] data, boolean copy)
	BaseDataBuffer(float[] data)
	BaseDataBuffer(float[] data, boolean copy)
protected	BaseDataBuffer(int length) Instantiate a buffer with the given length
	BaseDataBuffer(int[] data)
	BaseDataBuffer(int[] data, boolean copy)
	BaseDataBuffer(int length, int elementSize)

Method Summary

Modifier and Type	Method and Description
void	addReferencing(String id) Add a referencing element to this buffer
DataBuffer.AllocationMode	allocationMode() Allocation mode for buffers
Object	array() Returns the backing array of this buffer (if there is one)
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.
io.netty.buffer.ByteBuf	asNetty() Returns a view of this as a netty byte buffer
ByteBuffer	asNio() Returns a view of this as an nio byte buffer
DoubleBuffer	asNioDouble() Returns a view of this as an nio byte buffer
FloatBuffer	asNioFloat() Returns a view of this as an nio byte buffer
void	assign(DataBuffer... buffers) Assign the given data buffers to this buffer
void	assign(DataBuffer data) Assign the contents of this buffer to this buffer
void	assign(int[] indices, double[] data, boolean contiguous) Assign the given elements to the given indices
void	assign(int[] indices, double[] data, boolean contiguous, int inc) Assign the given elements to the given indices
void	assign(int[] indices, float[] data, boolean contiguous) Assign the given elements to the given indices
void	assign(int[] indices, float[] data, boolean contiguous, int inc) Assign the given elements to the given indices
void	assign(int[] offsets, int[] strides, DataBuffer... buffers) Assign the given buffers to this buffer based on the given offsets and strides.
void	assign(int[] offsets, int[] strides, long n, DataBuffer... buffers) Assign the given buffers to this buffer based on the given offsets and strides.
void	assign(Number value) Assign the given value to the buffer
void	assign(Number value, int offset) Assign the given value to the buffer starting at offset
void	copyAtStride(DataBuffer buf, int n, int stride, int yStride, int offset, int yOffset) Copies from the given buffer at the specified stride for up to n elements
abstract DataBuffer	create(io.netty.buffer.ByteBuf buf, int length) Create the data buffer with respect to the given byte buffer
abstract DataBuffer	create(double[] data) Create the data buffer with respect to the given byte buffer
abstract DataBuffer	create(float[] data) Create the data buffer with respect to the given byte buffer
protected abstract DataBuffer	create(int length) Create with length
abstract DataBuffer	create(int[] data) Create the data buffer with respect to the given byte buffer
void	destroy() release all resources for this buffer
boolean	dirty() Whether the buffer is dirty: aka has been updated
protected void	doReadObject(ObjectInputStream s)
DataBuffer	dup() Return a copy of this buffer
boolean	equals(Object o)
void	flush() Flush the data buffer
IComplexNumber	getComplex(int i) Returns a complex number
IComplexDouble	getComplexDouble(int i) Get the complex double at the specified index
IComplexFloat	getComplexFloat(int i) Get the complex float
double	getDouble(int i) Get element i in the buffer as a double
double[]	getDoublesAt(int offset, int length) Get the doubles at a particular offset
double[]	getDoublesAt(int offset, int inc, int length) Get the doubles at a particular offset
float	getFloat(int i) Get element i in the buffer as a double
float[]	getFloatsAt(int offset, int length) Get the doubles at a particular offset
float[]	getFloatsAt(int offset, int inc, int length) Get the doubles at a particular offset
int	getInt(int ix) Get the int at the specified index
Number	getNumber(int i) Get element i in the buffer as a double
int	hashCode()
boolean	isPersist() Whether the buffer should be persistent.
int	length() Returns the length of the buffer
void	persist() Mark this buffer as persistent
void	put(int i, double 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, IComplexNumber result) Insert a complex number at the given index
void	put(int i, int element) Assign an element in the buffer to the specified index
protected void	read(DataInputStream s)
void	read(InputStream is) Write this buffer to the input stream.
Collection<String>	references() The referencers pointing to this buffer
void	removeReferencing(String id) Remove the referenced id if it exists
void	setData(double[] data) Set the data for this buffer
void	setData(float[] data) Set the data for this buffer
void	setData(int[] data) Set the data for this buffer
protected void	setNioBuffer()
String	toString()
void	unPersist() Un persist the buffer
protected void	write(DataOutputStream out)
void	write(OutputStream dos) Write this buffer to the output stream

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

dataType, getElementSize

Field Detail

length

protected int length

elementSize

protected int elementSize

wrappedBuffer

protected transient ByteBuffer wrappedBuffer

referencing

protected Collection<String> referencing

ref

protected transient WeakReference<DataBuffer> ref

isPersist

protected boolean isPersist

allocationMode

protected DataBuffer.AllocationMode allocationMode

doubleData

protected double[] doubleData

intData

protected int[] intData

floatData

protected float[] floatData

dirty

protected AtomicBoolean dirty

Constructor Detail

BaseDataBuffer

protected BaseDataBuffer(io.netty.buffer.ByteBuf buf,
                         int length)

Parameters:

buf -

length -

BaseDataBuffer

public BaseDataBuffer(float[] data,
                      boolean copy)

Parameters:

data -

copy -

BaseDataBuffer

public BaseDataBuffer(double[] data,
                      boolean copy)

Parameters:

data -

copy -

BaseDataBuffer

public BaseDataBuffer(int[] data,
                      boolean copy)

Parameters:

data -

copy -

BaseDataBuffer

public BaseDataBuffer(double[] data)

BaseDataBuffer

public BaseDataBuffer(int[] data)

BaseDataBuffer

public BaseDataBuffer(float[] data)

BaseDataBuffer

public BaseDataBuffer(int length,
                      int elementSize)

BaseDataBuffer

public BaseDataBuffer(ByteBuffer buffer,
                      int length)

Create a data buffer from the given length

Parameters:

buffer -

length -

BaseDataBuffer

public BaseDataBuffer(byte[] data,
                      int length)

BaseDataBuffer

protected BaseDataBuffer(int length)

Instantiate a buffer with the given length

Parameters:

length - the length of the buffer

Method Detail

setNioBuffer

protected void setNioBuffer()

allocationMode

public DataBuffer.AllocationMode allocationMode()

Description copied from interface: DataBuffer

Allocation mode for buffers

Specified by:

allocationMode in interface DataBuffer

Returns:

the allocation mode for the buffer

persist

public void persist()

Description copied from interface: DataBuffer

Mark this buffer as persistent

Specified by:

persist in interface DataBuffer

isPersist

public boolean isPersist()

Description copied from interface: DataBuffer

Whether the buffer should be persistent. This is mainly for the aggressive garbage collection strategy.

Specified by:

isPersist in interface DataBuffer

Returns:

whether the buffer should be persistent or not (default false)

unPersist

public void unPersist()

Description copied from interface: DataBuffer

Un persist the buffer

Specified by:

unPersist in interface DataBuffer

copyAtStride

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

Description copied from interface: DataBuffer

Copies from the given buffer at the specified stride for up to n elements

Specified by:

copyAtStride in interface DataBuffer

Parameters:

buf - the data buffer to copy from

n - the number of elements to copy

stride - the stride to copy at

removeReferencing

public void removeReferencing(String id)

Description copied from interface: DataBuffer

Remove the referenced id if it exists

Specified by:

removeReferencing in interface DataBuffer

Parameters:

id - the id to remove

references

public Collection<String> references()

Description copied from interface: DataBuffer

The referencers pointing to this buffer

Specified by:

references in interface DataBuffer

Returns:

the references pointing to this buffer

addReferencing

public void addReferencing(String id)

Description copied from interface: DataBuffer

Add a referencing element to this buffer

Specified by:

addReferencing in interface DataBuffer

Parameters:

id - the id to reference

assign

public void assign(int[] indices,
                   float[] data,
                   boolean contiguous,
                   int inc)

Description copied from interface: DataBuffer

Assign the given elements to the given indices

Specified by:

assign in interface DataBuffer

Parameters:

indices - the indices to assign

data - the data to assign

contiguous - whether the indices are contiguous or not

inc - the number to increment by when assigning

setData

public void setData(int[] data)

Description copied from interface: DataBuffer

Set the data for this buffer

Specified by:

setData in interface DataBuffer

Parameters:

data - the data for this buffer

setData

public void setData(float[] data)

Description copied from interface: DataBuffer

Set the data for this buffer

Specified by:

setData in interface DataBuffer

Parameters:

data - the data for this buffer

setData

public void setData(double[] data)

Description copied from interface: DataBuffer

Set the data for this buffer

Specified by:

setData in interface DataBuffer

Parameters:

data - the data for this buffer

assign

public void assign(int[] indices,
                   double[] data,
                   boolean contiguous,
                   int inc)

Description copied from interface: DataBuffer

Assign the given elements to the given indices

Specified by:

assign in interface DataBuffer

Parameters:

indices - the indices to assign

data - the data to assign

contiguous - whether the data is contiguous or not

inc - the number to increment by when assigning

assign

public void assign(DataBuffer data)

Description copied from interface: DataBuffer

Assign the contents of this buffer to this buffer

Specified by:

assign in interface DataBuffer

Parameters:

data - the data to assign

assign

public void assign(int[] indices,
                   float[] data,
                   boolean contiguous)

Description copied from interface: DataBuffer

Assign the given elements to the given indices

Specified by:

assign in interface DataBuffer

Parameters:

indices - the indices to assign

data - the data to assign

contiguous - whether the indices are contiguous or not

assign

public void assign(int[] indices,
                   double[] data,
                   boolean contiguous)

Description copied from interface: DataBuffer

Assign the given elements to the given indices

Specified by:

assign in interface DataBuffer

Parameters:

indices - the indices to assign

data - the data to assign

contiguous - whether the data is contiguous or not

length

public int length()

Description copied from interface: DataBuffer

Returns the length of the buffer

Specified by:

length in interface DataBuffer

Returns:

the length of the buffer

assign

public void assign(Number value)

Description copied from interface: DataBuffer

Assign the given value to the buffer

Specified by:

assign in interface DataBuffer

Parameters:

value - the value to assign

getDoublesAt

public double[] getDoublesAt(int offset,
                             int length)

Description copied from interface: DataBuffer

Get the doubles at a particular offset

Specified by:

getDoublesAt in interface DataBuffer

Parameters:

offset - the offset to start

length - the length of the array

Returns:

the doubles at the specified offset and length

getFloatsAt

public float[] getFloatsAt(int offset,
                           int inc,
                           int length)

Description copied from interface: DataBuffer

Get the doubles at a particular offset

Specified by:

getFloatsAt in interface DataBuffer

Parameters:

offset - the offset to start

inc - the increment to use

length - the length of the array

Returns:

the doubles at the specified offset and length

dup

public DataBuffer dup()

Description copied from interface: DataBuffer

Return a copy of this buffer

Specified by:

dup in interface DataBuffer

Returns:

a copy of this buffer

create

protected abstract DataBuffer create(int length)

Create with length

Parameters:

length - a databuffer of the same type as this with the given length

Returns:

a data buffer with the same length and datatype as this one

create

public abstract DataBuffer create(double[] data)

Create the data buffer with respect to the given byte buffer

Parameters:

data - the buffer to create

Returns:

the data buffer based on the given buffer

create

public abstract DataBuffer create(float[] data)

Create the data buffer with respect to the given byte buffer

Parameters:

data - the buffer to create

Returns:

the data buffer based on the given buffer

create

public abstract DataBuffer create(int[] data)

Create the data buffer with respect to the given byte buffer

Parameters:

data - the buffer to create

Returns:

the data buffer based on the given buffer

create

public abstract DataBuffer create(io.netty.buffer.ByteBuf buf,
                                  int length)

Create the data buffer with respect to the given byte buffer

Parameters:

buf - the buffer to create

Returns:

the data buffer based on the given buffer

getDoublesAt

public double[] getDoublesAt(int offset,
                             int inc,
                             int length)

Description copied from interface: DataBuffer

Get the doubles at a particular offset

Specified by:

getDoublesAt in interface DataBuffer

Parameters:

offset - the offset to start

inc - the increment to use

length - the length of the array

Returns:

the doubles at the specified offset and length

getFloatsAt

public float[] getFloatsAt(int offset,
                           int length)

Description copied from interface: DataBuffer

Get the doubles at a particular offset

Specified by:

getFloatsAt in interface DataBuffer

Parameters:

offset - the offset to start

length - the length of the array

Returns:

the doubles at the specified offset and length

getComplexFloat

public IComplexFloat getComplexFloat(int i)

Description copied from interface: DataBuffer

Get the complex float

Specified by:

getComplexFloat in interface DataBuffer

Parameters:

i - the i togete

Returns:

the complex float at the specified index

getComplexDouble

public IComplexDouble getComplexDouble(int i)

Description copied from interface: DataBuffer

Get the complex double at the specified index

Specified by:

getComplexDouble in interface DataBuffer

Parameters:

i - the index

Returns:

the complex double

getComplex

public IComplexNumber getComplex(int i)

Description copied from interface: DataBuffer

Returns a complex number

Specified by:

getComplex in interface DataBuffer

Parameters:

i - the complex number cto get

Returns:

the complex number to get

put

public void put(int i,
                IComplexNumber result)

Description copied from interface: DataBuffer

Insert a complex number at the given index

Specified by:

put in interface DataBuffer

Parameters:

i - the index to insert

result - the element to insert

assign

public void assign(int[] offsets,
                   int[] strides,
                   DataBuffer... buffers)

Description copied from interface: DataBuffer

Assign the given buffers to this buffer based on the given offsets and strides. Note that the offsets and strides must be of equal length to the number of buffers

Specified by:

assign in interface DataBuffer

Parameters:

offsets - the offsets to use

strides - the strides to use

buffers - the buffers to assign data from

asBytes

public byte[] asBytes()

Description copied from interface: DataBuffer

Raw byte array storage

Specified by:

asBytes in interface DataBuffer

Returns:

the data represented as a raw byte array

asFloat

public float[] asFloat()

Description copied from interface: DataBuffer

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

Specified by:

asFloat in interface DataBuffer

Returns:

the buffer as a float

asDouble

public double[] asDouble()

Description copied from interface: DataBuffer

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

Specified by:

asDouble in interface DataBuffer

Returns:

the buffer as a float

asInt

public int[] asInt()

Description copied from interface: DataBuffer

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

Specified by:

asInt in interface DataBuffer

Returns:

the buffer as a float

getDouble

public double getDouble(int i)

Description copied from interface: DataBuffer

Get element i in the buffer as a double

Specified by:

getDouble in interface DataBuffer

Parameters:

i - the element to getFloat

Returns:

the element at this index

getFloat

public float getFloat(int i)

Description copied from interface: DataBuffer

Get element i in the buffer as a double

Specified by:

getFloat in interface DataBuffer

Parameters:

i - the element to getFloat

Returns:

the element at this index

getNumber

public Number getNumber(int i)

Description copied from interface: DataBuffer

Get element i in the buffer as a double

Specified by:

getNumber in interface DataBuffer

Parameters:

i - the element to getFloat

Returns:

the element at this index

put

public void put(int i,
                float element)

Description copied from interface: DataBuffer

Assign an element in the buffer to the specified index

Specified by:

put in interface DataBuffer

Parameters:

i - the index

element - the element to assign

put

public void put(int i,
                double element)

Description copied from interface: DataBuffer

Assign an element in the buffer to the specified index

Specified by:

put in interface DataBuffer

Parameters:

i - the index

element - the element to assign

dirty

public boolean dirty()

Description copied from interface: DataBuffer

Whether the buffer is dirty: aka has been updated

Specified by:

dirty in interface DataBuffer

Returns:

true if the buffer has been updated, false otherwise

asNioDouble

public DoubleBuffer asNioDouble()

Description copied from interface: DataBuffer

Returns a view of this as an nio byte buffer

Specified by:

asNioDouble in interface DataBuffer

Returns:

a view of this as an nio double buffer

asNioFloat

public FloatBuffer asNioFloat()

Description copied from interface: DataBuffer

Returns a view of this as an nio byte buffer

Specified by:

asNioFloat in interface DataBuffer

Returns:

a view of this as an nio float buffer

asNio

public ByteBuffer asNio()

Description copied from interface: DataBuffer

Returns a view of this as an nio byte buffer

Specified by:

asNio in interface DataBuffer

Returns:

a view of this as an nio byte buffer

asNetty

public io.netty.buffer.ByteBuf asNetty()

Description copied from interface: DataBuffer

Returns a view of this as a netty byte buffer

Specified by:

asNetty in interface DataBuffer

Returns:

a reference to this as a netty byte buffer

put

public void put(int i,
                int element)

Description copied from interface: DataBuffer

Assign an element in the buffer to the specified index

Specified by:

put in interface DataBuffer

Parameters:

i - the index

element - the element to assign

assign

public void assign(Number value,
                   int offset)

Description copied from interface: DataBuffer

Assign the given value to the buffer starting at offset

Specified by:

assign in interface DataBuffer

Parameters:

value - assign the value to set

offset - the offset to start at

write

public void write(OutputStream dos)

Description copied from interface: DataBuffer

Write this buffer to the output stream

Specified by:

write in interface DataBuffer

Parameters:

dos - the output stream to write

read

public void read(InputStream is)

Description copied from interface: DataBuffer

Write this buffer to the input stream.

Specified by:

read in interface DataBuffer

Parameters:

is - the inpus tream to write to

flush

public void flush()

Description copied from interface: DataBuffer

Flush the data buffer

Specified by:

flush in interface DataBuffer

getInt

public int getInt(int ix)

Description copied from interface: DataBuffer

Get the int at the specified index

Specified by:

getInt in interface DataBuffer

Parameters:

ix - the int at the specified index

Returns:

the int at the specified index

assign

public void assign(int[] offsets,
                   int[] strides,
                   long n,
                   DataBuffer... buffers)

Description copied from interface: DataBuffer

Assign the given buffers to this buffer based on the given offsets and strides. Note that the offsets and strides must be of equal length to the number of buffers

Specified by:

assign in interface DataBuffer

Parameters:

offsets - the offsets to use

strides - the strides to use

n - the number of elements to operate on

buffers - the buffers to assign data from

assign

public void assign(DataBuffer... buffers)

Description copied from interface: DataBuffer

Assign the given data buffers to this buffer

Specified by:

assign in interface DataBuffer

Parameters:

buffers - the buffers to assign

destroy

public void destroy()

Description copied from interface: DataBuffer

release all resources for this buffer

Specified by:

destroy in interface DataBuffer

equals

public boolean equals(Object o)

Overrides:

equals in class Object

doReadObject

protected void doReadObject(ObjectInputStream s)

read

protected void read(DataInputStream s)

write

protected void write(DataOutputStream out)
              throws IOException

Throws:

IOException

array

public Object array()

Description copied from interface: DataBuffer

Returns the backing array of this buffer (if there is one)

Specified by:

array in interface DataBuffer

Returns:

the backing array of this buffer

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object