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

Class FunctionMatrix

java.lang.Object

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

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

All Implemented Interfaces:

Externalizable, Serializable, Destroyable, Matrix, MetaAttributes, StorageOpsMetrics

public class FunctionMatrix
extends AbstractMatrix

Implementation of Matrix that maps row and column index to java.util.function interfaces.

See Also:

Serialized Form

Nested Class Summary

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

Matrix.Element

Constructor Summary

Constructors

Constructor and Description
FunctionMatrix()
FunctionMatrix(int rows, int cols, IntIntToDoubleFunction getFunc) Creates read-only function matrix.
FunctionMatrix(int rows, int cols, IntIntToDoubleFunction getFunc, IntIntDoubleToVoidFunction setFunc) Creates read-write or read-only function matrix.

Method Summary

Modifier and Type	Method and Description
Matrix	copy() Clones this matrix.
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.

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

allSpliterator, assign, assign, assign, assign, assignColumn, assignRow, columnSize, compute, density, destroy, determinant, divide, equals, foldColumns, foldMap, foldRows, get, getCol, getElement, getMaxAmountOfColumns, getMetaStorage, getRow, getStorage, getX, guid, hashCode, inverse, isArrayBased, isDense, isDistributed, isRandomAccess, isSequentialAccess, likeIdentity, map, map, maxAbsRowSumNorm, maxElement, maxValue, minElement, minus, minValue, nonZeroElements, nonZeroSpliterator, plus, plus, readExternal, rowSize, set, setColumn, setRow, setStorage, setX, storageGet, storageSet, sum, swapColumns, swapRows, times, times, times, 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.MetaAttributes

getAttribute, hasAttribute, removeAttribute, setAttribute

Constructor Detail

FunctionMatrix

public FunctionMatrix()

FunctionMatrix

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

Creates read-write or read-only function matrix.

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.

FunctionMatrix

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

Creates read-only function matrix.

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

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.

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.

Parameters:

crd - Cardinality of the vector.

Returns:

Newly created empty vector "compatible" to this matrix.