org.apache.ignite.ml.math.impls.storage.matrix

Class DenseOffHeapMatrixStorage

java.lang.Object

org.apache.ignite.ml.math.impls.storage.matrix.DenseOffHeapMatrixStorage

All Implemented Interfaces:

Externalizable, Serializable, Destroyable, MatrixStorage, StorageOpsMetrics

public class DenseOffHeapMatrixStorage
extends Object
implements MatrixStorage

Local, dense off-heap matrix storage.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DenseOffHeapMatrixStorage()
DenseOffHeapMatrixStorage(double[][] data)
DenseOffHeapMatrixStorage(int rows, int cols)

Method Summary

Modifier and Type	Method and Description
int	accessMode()
int	columnSize()
double[]	data() Gets underlying data, if StorageOpsMetrics.isArrayBased() returns false this method return copy of data.
void	destroy() Destroys object if managed outside of JVM.
boolean	equals(Object obj)
double	get(int x, int y)
int	hashCode()
boolean	isArrayBased() Checks if implementation is based on Java arrays.
boolean	isDense() Checks if this implementation should be considered dense so that it explicitly represents every value.
boolean	isDistributed() Checks whether implementation is JVM-local or distributed (multi-JVM).
boolean	isRandomAccess() Checks if this implementation is optimized for random access.
boolean	isSequentialAccess() Checks if this implementation should be considered to be iterable in index order in an efficient way.
void	readExternal(ObjectInput in)
int	rowSize()
void	set(int x, int y, double v)
int	storageMode()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DenseOffHeapMatrixStorage

public DenseOffHeapMatrixStorage()

DenseOffHeapMatrixStorage

public DenseOffHeapMatrixStorage(int rows,
                                 int cols)

Parameters:

rows - Amount of rows in the matrix.

cols - Amount of columns in the matrix.

DenseOffHeapMatrixStorage

public DenseOffHeapMatrixStorage(double[][] data)

Parameters:

data - Backing data array.

Method Detail

get

public double get(int x,
                  int y)

Specified by:

get in interface MatrixStorage

Parameters:

x - Matrix row index.

y - Matrix column index.

Returns:

Value corresponding to given row and column.

set

public void set(int x,
                int y,
                double v)

Specified by:

set in interface MatrixStorage

Parameters:

x - Matrix row index.

y - Matrix column index.

v - Value to set at given row and column.

columnSize

public int columnSize()

Specified by:

columnSize in interface MatrixStorage

isSequentialAccess

public boolean isSequentialAccess()

Checks if this implementation should be considered to be iterable in index order in an efficient way.

Specified by:

isSequentialAccess in interface StorageOpsMetrics

isDense

public boolean isDense()

Checks if this implementation should be considered dense so that it explicitly represents every value.

Specified by:

isDense in interface StorageOpsMetrics

isRandomAccess

public boolean isRandomAccess()

Checks if this implementation is optimized for random access.

Specified by:

isRandomAccess in interface StorageOpsMetrics

isDistributed

public boolean isDistributed()

Checks whether implementation is JVM-local or distributed (multi-JVM).

Specified by:

isDistributed in interface StorageOpsMetrics

rowSize

public int rowSize()

Specified by:

rowSize in interface MatrixStorage

storageMode

public int storageMode()

Specified by:

storageMode in interface MatrixStorage

Returns:

Matrix elements storage mode.

See Also:

StorageConstants

accessMode

public int accessMode()

Specified by:

accessMode in interface MatrixStorage

Returns:

Matrix access mode.

See Also:

StorageConstants

isArrayBased

public boolean isArrayBased()

Checks if implementation is based on Java arrays.

Specified by:

isArrayBased in interface StorageOpsMetrics

data

public double[] data()

Gets underlying data, if StorageOpsMetrics.isArrayBased() returns false this method return copy of data. The data must be adapted for Blas.

Specified by:

data in interface MatrixStorage

See Also:

StorageOpsMetrics.isArrayBased()

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

destroy

public void destroy()

Destroys object if managed outside of JVM. It's a no-op in all other cases.

Specified by:

destroy in interface Destroyable

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object