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

Class PivotedMatrixView

java.lang.Object

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

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

All Implemented Interfaces:

Externalizable, Serializable, Destroyable, Matrix, MetaAttributes, StorageOpsMetrics

public class PivotedMatrixView
extends AbstractMatrix

Pivoted (index mapped) view over another matrix implementation.

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
PivotedMatrixView()
PivotedMatrixView(Matrix mtx)
PivotedMatrixView(Matrix mtx, int[] pivot)
PivotedMatrixView(Matrix mtx, int[] rowPivot, int[] colPivot)

Method Summary

Modifier and Type	Method and Description
int[]	columnPivot()
int	columnPivot(int i)
int	columnUnpivot(int i)
Matrix	copy() Clones this matrix.
boolean	equals(Object o) We ignore guid's for comparisons.
Matrix	getBaseMatrix()
int	hashCode()
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.
void	readExternal(ObjectInput in)
int[]	rowPivot()
int	rowPivot(int i)
int	rowUnpivot(int i)
Matrix	swap(int i, int j) Swaps indexes i and j for both both row and column.
Matrix	swapColumns(int i, int j) Swaps two columns in this matrix.
Matrix	swapRows(int i, int j) Swaps two rows in this matrix.
Vector	viewColumn(int col) Creates new view into matrix column .
Vector	viewRow(int row) Creates new view into matrix row.
void	writeExternal(ObjectOutput out)

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, foldColumns, foldMap, foldRows, get, getCol, getElement, getMaxAmountOfColumns, getMetaStorage, getRow, getStorage, getX, guid, inverse, isArrayBased, isDense, isDistributed, isRandomAccess, isSequentialAccess, likeIdentity, map, map, maxAbsRowSumNorm, maxElement, maxValue, minElement, minus, minValue, nonZeroElements, nonZeroSpliterator, plus, plus, rowSize, set, setColumn, setRow, setStorage, setX, storageGet, storageSet, sum, times, times, times, toString, transpose, viewDiagonal, viewPart, viewPart

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

PivotedMatrixView

public PivotedMatrixView()

PivotedMatrixView

public PivotedMatrixView(Matrix mtx,
                         int[] rowPivot,
                         int[] colPivot)

Parameters:

mtx - Parent matrix.

rowPivot - Pivot array for rows.

colPivot - Pivot array for columns.

PivotedMatrixView

public PivotedMatrixView(Matrix mtx)

Parameters:

mtx - Parent matrix.

PivotedMatrixView

public PivotedMatrixView(Matrix mtx,
                         int[] pivot)

Parameters:

mtx - Parent matrix.

pivot - Pivot array for rows and columns.

Method Detail

swap

public Matrix swap(int i,
                   int j)

Swaps indexes i and j for both both row and column.

Parameters:

i - First index to swap.

j - Second index to swap.

swapRows

public Matrix swapRows(int i,
                       int j)

Swaps two rows in this matrix.

Specified by:

swapRows in interface Matrix

Overrides:

swapRows in class AbstractMatrix

Parameters:

i - Row #1.

j - Row #2.

Returns:

This matrix.

swapColumns

public Matrix swapColumns(int i,
                          int j)

Swaps two columns in this matrix.

Specified by:

swapColumns in interface Matrix

Overrides:

swapColumns in class AbstractMatrix

Parameters:

i - Column #1.

j - Column #2.

Returns:

This matrix.

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.

getBaseMatrix

public Matrix getBaseMatrix()

Returns:

Parent matrix.

rowPivot

public int[] rowPivot()

Returns:

Pivot array for rows.

columnPivot

public int[] columnPivot()

Returns:

Pivot array for columns.

rowPivot

public int rowPivot(int i)

Parameters:

i - Index for row pivot.

Returns:

Row pivot for given index.

columnPivot

public int columnPivot(int i)

Parameters:

i - Index for column pivot.

Returns:

Column pivot for given index.

rowUnpivot

public int rowUnpivot(int i)

Parameters:

i - Index for row unpivot.

Returns:

Row unpivot for given index.

columnUnpivot

public int columnUnpivot(int i)

Parameters:

i - Index for column unpivot.

Returns:

Column unpivot for given index.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class AbstractMatrix

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class AbstractMatrix

Throws:

IOException

ClassNotFoundException

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.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractMatrix

equals

public boolean equals(Object o)

We ignore guid's for comparisons.

Overrides:

equals in class AbstractMatrix