io.nem.core.math

Class DenseMatrix

java.lang.Object

io.nem.core.math.Matrix

io.nem.core.math.DenseMatrix

public final class DenseMatrix
extends Matrix

Represents a dense 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
DenseMatrix(int rows, int cols) Creates a new matrix of the specified size.
DenseMatrix(int rows, int cols, double[] values) Creates a new matrix of the specified size and values.

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.
protected double	getAtUnchecked(int row, int col) Gets the value at the specified row and column.
MatrixNonZeroElementRowIterator	getNonZeroElementRowIterator(int row) Gets the non-zero matrix row element iterator for a given row index.
double[]	getRaw() Gets the underlying, raw array.
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, forEach, 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

DenseMatrix

public DenseMatrix(int rows,
                   int cols)

Creates a new matrix of the specified size.

Parameters:

rows - The desired number of rows.

cols - The desired number of columns.

DenseMatrix

public DenseMatrix(int rows,
                   int cols,
                   double[] values)

Creates a new matrix of the specified size and values.

Parameters:

rows - The desired number of rows.

cols - The desired number of columns.

values - The specified values.

Method Detail

getRaw

public double[] getRaw()

Gets the underlying, raw array.

Returns:

The underlying, raw array.

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.

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.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object