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

Class FunctionMatrixStorage

java.lang.Object

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

All Implemented Interfaces:

Externalizable, Serializable, Destroyable, MatrixStorage, StorageOpsMetrics

public class FunctionMatrixStorage
extends Object
implements MatrixStorage

Read-only or read-write function-based matrix storage.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FunctionMatrixStorage()
FunctionMatrixStorage(int rows, int cols, IntIntToDoubleFunction getFunc)
FunctionMatrixStorage(int rows, int cols, IntIntToDoubleFunction getFunc, IntIntDoubleToVoidFunction setFunc)

Method Summary

Modifier and Type	Method and Description
int	accessMode()
int	columnSize()
boolean	equals(Object o)
double	get(int x, int y)
IntIntToDoubleFunction	getFunction()
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)
IntIntDoubleToVoidFunction	setFunction()
int	storageMode()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ignite.ml.math.MatrixStorage

data

Methods inherited from interface org.apache.ignite.ml.math.Destroyable

destroy

Constructor Detail

FunctionMatrixStorage

public FunctionMatrixStorage()

FunctionMatrixStorage

public FunctionMatrixStorage(int rows,
                             int cols,
                             IntIntToDoubleFunction getFunc,
                             IntIntDoubleToVoidFunction setFunc)

Parameters:

rows - Amount of rows in the matrix.

cols - Amount of columns in the matrix.

getFunc - Function that returns value corresponding to given row and column index.

setFunc - Set function. If null - this will be a read-only matrix.

FunctionMatrixStorage

public FunctionMatrixStorage(int rows,
                             int cols,
                             IntIntToDoubleFunction getFunc)

Parameters:

rows - Amount of rows in the matrix.

cols - Amount of columns in the matrix.

getFunc - Function that returns value corresponding to given row and column index.

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.

getFunction

public IntIntToDoubleFunction getFunction()

Returns:

Getter function.

setFunction

public IntIntDoubleToVoidFunction setFunction()

Returns:

Setter function.

columnSize

public int columnSize()

Specified by:

columnSize in interface MatrixStorage

rowSize

public int rowSize()

Specified by:

rowSize in interface MatrixStorage

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

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

isArrayBased

public boolean isArrayBased()

Checks if implementation is based on Java arrays.

Specified by:

isArrayBased in interface StorageOpsMetrics

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object