io.nem.core.math

Class SparseMatrix

java.lang.Object

io.nem.core.math.Matrix

io.nem.core.math.SparseMatrix

public class SparseMatrix
extends Matrix

Represents a sparse matrix.

Nested Class Summary

Nested classes/interfaces inherited from class io.nem.core.math.Matrix

Matrix.ElementVisitorFunction, Matrix.ReadOnlyElementVisitorFunction

Constructor Summary

Constructors

Constructor and Description
SparseMatrix(int numRows, int numCols, int initialCapacityPerRow) Creates a new matrix of the specified size which has a given capacity for each row.

Method Summary

Modifier and Type	Method and Description
protected Matrix	create(int numRows, int numCols) Creates a new matrix.
protected void	forEach(Matrix.ElementVisitorFunction func) Calls the specified function for every non-zero element.
void	forEach(Matrix.ReadOnlyElementVisitorFunction func) Calls the specified function for every non-zero element.
protected double	getAtUnchecked(int row, int col) Gets the value at the specified row and column.
int	getNonZeroColumnCount(int row) Gets the number of non zero columns of a row.
MatrixNonZeroElementRowIterator	getNonZeroElementRowIterator(int row) Gets the non-zero matrix row element iterator for a given row index.
int	getNumEntries() Returns the number of entries (values that have been set) in this sparse matrix.
int	getRowCapacity(int row) Gets the capacity of a row.
protected void	setAtUnchecked(int row, int col, double val) Sets a value at the specified row and column.
java.lang.String	toString()

Methods inherited from class io.nem.core.math.Matrix

abs, absSum, add, addElementWise, equals, getAt, getColumnCount, getColumnSumVector, getElementCount, getRowCount, getRowSumVector, hashCode, incrementAt, isSameSize, isZeroMatrix, multiply, multiply, multiplyElementWise, normalizeColumns, removeLessThan, removeNegatives, roundTo, scale, setAt, sqrt, sum, transpose

Methods inherited from class java.lang.Object

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

Constructor Detail

SparseMatrix

public SparseMatrix(int numRows,
                    int numCols,
                    int initialCapacityPerRow)

Creates a new matrix of the specified size which has a given capacity for each row.

Parameters:

numRows - The desired number of rows to represent.

numCols - The desired number of columns to represent.

initialCapacityPerRow - The initial capacity of a row. Choose carefully to avoid reallocation!

Method Detail

create

protected final Matrix create(int numRows,
                              int numCols)

Description copied from class: Matrix

Creates a new matrix.

Specified by:

create in class Matrix

Parameters:

numRows - The number of rows.

numCols - The number of columns.

Returns:

Created matrix.

getAtUnchecked

protected final double getAtUnchecked(int row,
                                      int col)

Description copied from class: Matrix

Gets the value at the specified row and column.

Specified by:

getAtUnchecked in class Matrix

Parameters:

row - The row.

col - The column.

Returns:

The value.

setAtUnchecked

protected final void setAtUnchecked(int row,
                                    int col,
                                    double val)

Description copied from class: Matrix

Sets a value at the specified row and column.

Specified by:

setAtUnchecked in class Matrix

Parameters:

row - The row.

col - The column.

val - The value.

forEach

protected final void forEach(Matrix.ElementVisitorFunction func)

Description copied from class: Matrix

Calls the specified function for every non-zero element.

Specified by:

forEach in class Matrix

Parameters:

func - The function.

forEach

public final void forEach(Matrix.ReadOnlyElementVisitorFunction func)

Description copied from class: Matrix

Calls the specified function for every non-zero element.

Overrides:

forEach in class Matrix

Parameters:

func - The function.

getNonZeroElementRowIterator

public MatrixNonZeroElementRowIterator getNonZeroElementRowIterator(int row)

Description copied from class: Matrix

Gets the non-zero matrix row element iterator for a given row index.

Specified by:

getNonZeroElementRowIterator in class Matrix

Parameters:

row - The row index.

Returns:

The iterator.

getNonZeroColumnCount

public int getNonZeroColumnCount(int row)

Gets the number of non zero columns of a row.

Parameters:

row - The row.

Returns:

The number of non zero columns.

getRowCapacity

public int getRowCapacity(int row)

Gets the capacity of a row.

Parameters:

row - The row.

Returns:

The capacity of the row.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getNumEntries

public int getNumEntries()

Returns the number of entries (values that have been set) in this sparse matrix.

Returns:

number of entries in this sparse matrix.