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

Class SparseDistributedMatrix

java.lang.Object

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

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

All Implemented Interfaces:

Externalizable, Serializable, Destroyable, Matrix, MetaAttributes, StorageConstants, StorageOpsMetrics

public class SparseDistributedMatrix
extends AbstractMatrix
implements StorageConstants

Sparse distributed matrix implementation based on data grid.

Unlike CacheMatrix that is based on existing cache, this implementation creates distributed cache internally and doesn't rely on pre-existing cache.

You also need to call AbstractMatrix.destroy() to remove the underlying cache when you no longer need this matrix.

This class is not intended for fast calculations (for example, matrix multiplication). If better performance is needed, SparseBlockDistributedMatrix should be used instead.

Currently fold supports only commutative operations.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.ignite.ml.math.Matrix

Matrix.Element

Field Summary

Fields inherited from interface org.apache.ignite.ml.math.StorageConstants

COLUMN_STORAGE_MODE, RANDOM_ACCESS_MODE, ROW_STORAGE_MODE, SEQUENTIAL_ACCESS_MODE, UNKNOWN_STORAGE_MODE

Constructor Summary

Constructors

Constructor and Description
SparseDistributedMatrix()
SparseDistributedMatrix(double[][] data)
SparseDistributedMatrix(int rows, int cols)
SparseDistributedMatrix(int rows, int cols, int stoMode, int acsMode)

Method Summary

Modifier and Type	Method and Description
Matrix	assign(double val) Assigns given value to all elements of this matrix.
Matrix	copy() Clones this matrix.
Matrix	divide(double d) Return the same matrix with updates values (broken contract).
UUID	getUUID()
Matrix	like(int rows, int cols) Creates new empty matrix of the same underlying class but of different size.
Vector	likeVector(int crd) Creates new empty vector of compatible properties (similar or the same flavor) to this matrix.
Matrix	map(IgniteDoubleFunction<Double> fun) Maps all values in this matrix through a given function.
double	maxValue() Gets the maximum value in this matrix.
double	minValue() Gets the minimum value in this matrix.
Matrix	plus(double x) Return the same matrix with updates values (broken contract).
double	sum() Gets sum of all elements in the matrix.
Matrix	times(double x) Return the same matrix with updates values (broken contract).
Matrix	times(Matrix mtx) Creates new matrix that is the product of multiplying this matrix and the argument matrix.
Vector	times(Vector vec) Creates new matrix that is the product of multiplying this matrix and the argument vector.

Methods inherited from class org.apache.ignite.ml.math.impls.matrix.AbstractMatrix

allSpliterator, assign, assign, assign, assignColumn, assignRow, columnSize, compute, density, destroy, determinant, equals, foldColumns, foldMap, foldRows, get, getCol, getElement, getMaxAmountOfColumns, getMetaStorage, getRow, getStorage, getX, guid, hashCode, inverse, isArrayBased, isDense, isDistributed, isRandomAccess, isSequentialAccess, likeIdentity, map, maxAbsRowSumNorm, maxElement, minElement, minus, nonZeroElements, nonZeroSpliterator, plus, readExternal, rowSize, set, setColumn, setRow, setStorage, setX, storageGet, storageSet, swapColumns, swapRows, toString, transpose, viewColumn, viewDiagonal, viewPart, viewPart, viewRow, writeExternal

Methods inherited from class java.lang.Object

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

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

assertAccessMode, assertStorageMode

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

getAttribute, hasAttribute, removeAttribute, setAttribute

Constructor Detail

SparseDistributedMatrix

public SparseDistributedMatrix()

SparseDistributedMatrix

public SparseDistributedMatrix(int rows,
                               int cols,
                               int stoMode,
                               int acsMode)

Parameters:

rows - Amount of rows in the matrix.

cols - Amount of columns in the matrix.

stoMode - Matrix storage mode.

acsMode - Matrix elements access mode.

SparseDistributedMatrix

public SparseDistributedMatrix(double[][] data)

Parameters:

data - Data to fill the matrix

SparseDistributedMatrix

public SparseDistributedMatrix(int rows,
                               int cols)

Parameters:

rows - Amount of rows in the matrix.

cols - Amount of columns in the matrix.

Method Detail

divide

public Matrix divide(double d)

Return the same matrix with updates values (broken contract).

Specified by:

divide in interface Matrix

Overrides:

divide in class AbstractMatrix

Parameters:

d - Value to divide to.

Returns:

This matrix.

plus

public Matrix plus(double x)

Return the same matrix with updates values (broken contract).

Specified by:

plus in interface Matrix

Overrides:

plus in class AbstractMatrix

Parameters:

x - Value to add.

Returns:

New matrix of the same underlying class and size.

times

public Matrix times(double x)

Return the same matrix with updates values (broken contract).

Specified by:

times in interface Matrix

Overrides:

times in class AbstractMatrix

Parameters:

x - Value to multiply.

Returns:

New matrix.

times

public Matrix times(Matrix mtx)

Creates new matrix that is the product of multiplying this matrix and the argument matrix.

Specified by:

times in interface Matrix

Overrides:

times in class AbstractMatrix

Parameters:

mtx - Argument matrix.

Returns:

New matrix.

times

public Vector times(Vector vec)

Creates new matrix that is the product of multiplying this matrix and the argument vector.

Specified by:

times in interface Matrix

Overrides:

times in class AbstractMatrix

Parameters:

vec - Argument vector.

Returns:

New matrix.

assign

public Matrix assign(double val)

Assigns given value to all elements of this matrix.

Specified by:

assign in interface Matrix

Overrides:

assign in class AbstractMatrix

Parameters:

val - Value to assign to all elements.

Returns:

This matrix.

map

public Matrix map(IgniteDoubleFunction<Double> fun)

Maps all values in this matrix through a given function.

Specified by:

map in interface Matrix

Overrides:

map in class AbstractMatrix

Parameters:

fun - Mapping function.

Returns:

This matrix.

sum

public double sum()

Gets sum of all elements in the matrix.

Specified by:

sum in interface Matrix

Overrides:

sum in class AbstractMatrix

Returns:

Sum of all elements in this matrix.

maxValue

public double maxValue()

Gets the maximum value in this matrix.

Specified by:

maxValue in interface Matrix

Overrides:

maxValue in class AbstractMatrix

Returns:

Maximum value in this matrix.

minValue

public double minValue()

Gets the minimum value in this matrix.

Specified by:

minValue in interface Matrix

Overrides:

minValue in class AbstractMatrix

Returns:

Minimum value in this matrix.

copy

public Matrix copy()

Clones this matrix.

NOTE: new matrix will have the same flavor as the this matrix but a different ID.

Specified by:

copy in interface Matrix

Overrides:

copy in class AbstractMatrix

Returns:

New matrix of the same underlying class, the same size and the same values.

like

public Matrix like(int rows,
                   int cols)

Creates new empty matrix of the same underlying class but of different size.

NOTE: new matrix will have the same flavor as the this matrix but a different ID.

Specified by:

like in interface Matrix

Parameters:

rows - Number of rows for new matrix.

cols - Number of columns for new matrix.

Returns:

New matrix of the same underlying class and size.

likeVector

public Vector likeVector(int crd)

Creates new empty vector of compatible properties (similar or the same flavor) to this matrix.

Specified by:

likeVector in interface Matrix

Parameters:

crd - Cardinality of the vector.

Returns:

Newly created empty vector "compatible" to this matrix.

getUUID

public UUID getUUID()