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

Class DiagonalMatrix

java.lang.Object

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

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

All Implemented Interfaces:

Externalizable, Serializable, Destroyable, Matrix, MetaAttributes, StorageOpsMetrics

public class DiagonalMatrix
extends AbstractMatrix

Implementation of diagonal view of the Matrix.

See also: Wikipedia article.

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
DiagonalMatrix()
DiagonalMatrix(double[] vals)
DiagonalMatrix(int size, double val)
DiagonalMatrix(Matrix mtx)
DiagonalMatrix(Vector diagonal)

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.
Vector	viewColumn(int col) Creates new view into matrix column .
Vector	viewRow(int row) Creates new view into matrix row.

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, viewDiagonal, viewPart, viewPart, 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

DiagonalMatrix

public DiagonalMatrix()

DiagonalMatrix

public DiagonalMatrix(Vector diagonal)

Parameters:

diagonal - Backing Vector.

DiagonalMatrix

public DiagonalMatrix(Matrix mtx)

Parameters:

mtx - Backing Matrix.

DiagonalMatrix

public DiagonalMatrix(double[] vals)

Parameters:

vals - Backing array of values at diagonal.

DiagonalMatrix

public DiagonalMatrix(int size,
                      double val)

Parameters:

size - Size of diagonal.

val - Constant value at diagonal.

Method Detail

viewRow

public Vector viewRow(int row)

Creates new view into matrix row. Changes to the view will be propagated to this matrix.

Specified by:

viewRow in interface Matrix

Overrides:

viewRow in class AbstractMatrix

Parameters:

row - Row index.

Returns:

New view.

viewColumn

public Vector viewColumn(int col)

Creates new view into matrix column . Changes to the view will be propagated to this matrix.

Specified by:

viewColumn in interface Matrix

Overrides:

viewColumn in class AbstractMatrix

Parameters:

col - Column index.

Returns:

New view.

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.