Matrix (symbol-sdk-java 1.0.1 API)

java.lang.Object
- io.nem.symbol.core.math.Matrix

Direct Known Subclasses:

DenseMatrix, SparseMatrix
```
public abstract class Matrix
extends java.lang.Object
```
Abstract matrix class.
This class provides default implementations of most matrix functions but they should be optimized in derived classes when performance is important.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static interface`	`Matrix.ElementVisitorFunction` Functional interface that visits every non-zero element in this matrix.
`static interface`	`Matrix.ReadOnlyElementVisitorFunction` Functional interface that visits every non-zero element in this matrix.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Matrix(int numRows, int numCols)
Creates a new matrix.

Constructors
Modifier	Constructor and Description
`protected`	`Matrix(int numRows, int numCols)` Creates a new matrix.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Matrix`	`abs()` Creates a new matrix by taking the absolute value of this matrix.
`double`	`absSum()` Gets the sum of the absolute value of all the matrix's elements.
`Matrix`	`add(double scalar)` Creates a new matrix by adding each value in this matrix by a scalar.
`Matrix`	`addElementWise(Matrix matrix)` Creates a new Matrix by adding this matrix element-wise with another matrix.
`protected abstract Matrix`	`create(int numRows, int numCols)` Creates a new matrix.
`boolean`	`equals(java.lang.Object obj)`
`protected abstract 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.
`double`	`getAt(int row, int col)` Gets the value at the specified row and column.
`protected abstract double`	`getAtUnchecked(int row, int col)` Gets the value at the specified row and column.
`int`	`getColumnCount()` Gets the number of columns.
`ColumnVector`	`getColumnSumVector()` Gets a vector containing the sums of each matrix column.
`int`	`getElementCount()` Gets the number of elements.
`abstract MatrixNonZeroElementRowIterator`	`getNonZeroElementRowIterator(int row)` Gets the non-zero matrix row element iterator for a given row index.
`int`	`getRowCount()` Gets the number of rows.
`ColumnVector`	`getRowSumVector()` Gets a vector containing the sums of each matrix row.
`int`	`hashCode()`
`void`	`incrementAt(int row, int col, double val)` Increments a value at the specified row and column by the given val.
`boolean`	`isSameSize(Matrix matrix)` Determines if two this matrix and another matrix have the same dimensions.
`boolean`	`isZeroMatrix()` Determines if this matrix is a zero matrix.
`ColumnVector`	`multiply(ColumnVector vector)` Multiplies this matrix by a vector.
`Matrix`	`multiply(double scalar)` Creates a new matrix by multiplying this matrix by a scalar.
`Matrix`	`multiplyElementWise(Matrix matrix)` Creates a new Matrix by multiplying this matrix element-wise with another matrix.
`java.util.Collection<java.lang.Integer>`	`normalizeColumns()` Normalizes each column of the matrix.
`void`	`removeLessThan(double minValue)` Sets all values less than the specified value to zero.
`void`	`removeNegatives()` Sets all negative values to zero.
`Matrix`	`roundTo(int numPlaces)` Creates a new matrix by rounding all elements in this matrix to the specified number of decimal places.
`void`	`scale(double scale)` Scales this matrix by dividing all of its elements by the specified factor.
`void`	`setAt(int row, int col, double val)` Sets a value at the specified row and column.
`protected abstract void`	`setAtUnchecked(int row, int col, double val)` Sets a value at the specified row and column.
`Matrix`	`sqrt()` Creates a new matrix by taking the square root of this matrix.
`double`	`sum()` Gets the sum of all the matrix's elements.
`Matrix`	`transpose()` Transposes this matrix.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Matrix
```
protected Matrix(int numRows,
                 int numCols)
```
    Creates a new matrix.
    
    Parameters:
    
    numRows - The number of rows.
    
    numCols - The number of columns.
- Method Detail
  - getElementCount
```
public final int getElementCount()
```
    Gets the number of elements.
    
    Returns:
    
    The number of elements.
  - getRowCount
```
public final int getRowCount()
```
    Gets the number of rows.
    
    Returns:
    
    The number of rows.
  - getColumnCount
```
public final int getColumnCount()
```
    Gets the number of columns.
    
    Returns:
    
    The number of columns.
  - getAt
```
public final double getAt(int row,
                          int col)
```
    Gets the value at the specified row and column.
    
    Parameters:
    
    row - The row.
    
    col - The column.
    
    Returns:
    
    The value.
  - setAt
```
public final void setAt(int row,
                        int col,
                        double val)
```
    Sets a value at the specified row and column.
    
    Parameters:
    
    row - The row.
    
    col - The column.
    
    val - The value.
  - incrementAt
```
public final void incrementAt(int row,
                              int col,
                              double val)
```
    Increments a value at the specified row and column by the given val.
    
    Parameters:
    
    row - The row.
    
    col - The column.
    
    val - The value to increment by.
  - getRowSumVector
```
public final ColumnVector getRowSumVector()
```
    Gets a vector containing the sums of each matrix row.
    
    Returns:
    
    A vector containing the sums of each matrix row.
  - getColumnSumVector
```
public final ColumnVector getColumnSumVector()
```
    Gets a vector containing the sums of each matrix column.
    
    Returns:
    
    A vector containing the sums of each matrix column.
  - normalizeColumns
```
public java.util.Collection<java.lang.Integer> normalizeColumns()
```
    Normalizes each column of the matrix.
    
    Returns:
    
    The indexes of zero columns.
  - removeNegatives
```
public void removeNegatives()
```
    Sets all negative values to zero.
  - removeLessThan
```
public void removeLessThan(double minValue)
```
    Sets all values less than the specified value to zero.
    
    Parameters:
    
    minValue - The minimum value that should not be set to zero.
  - scale
```
public final void scale(double scale)
```
    Scales this matrix by dividing all of its elements by the specified factor.
    
    Parameters:
    
    scale - The scale factor.
  - multiplyElementWise
```
public Matrix multiplyElementWise(Matrix matrix)
```
    Creates a new Matrix by multiplying this matrix element-wise with another matrix.
    
    Parameters:
    
    matrix - The other matrix.
    
    Returns:
    
    The new matrix.
  - addElementWise
```
public Matrix addElementWise(Matrix matrix)
```
    Creates a new Matrix by adding this matrix element-wise with another matrix.
    
    Parameters:
    
    matrix - The other matrix.
    
    Returns:
    
    The new matrix.
  - absSum
```
public final double absSum()
```
    Gets the sum of the absolute value of all the matrix's elements.
    
    Returns:
    
    The sum of the absolute value of all the matrix's elements.
  - sum
```
public final double sum()
```
    Gets the sum of all the matrix's elements.
    
    Returns:
    
    The sum of all the matrix's elements.
  - multiply
```
public ColumnVector multiply(ColumnVector vector)
```
    Multiplies this matrix by a vector.
    
    Parameters:
    
    vector - The vector.
    
    Returns:
    
    The resulting vector.
  - transpose
```
public final Matrix transpose()
```
    Transposes this matrix.
    
    Returns:
    
    A transposed matrix.
  - roundTo
```
public Matrix roundTo(int numPlaces)
```
    Creates a new matrix by rounding all elements in this matrix to the specified number of decimal places.
    
    Parameters:
    
    numPlaces - The number of decimal places.
    
    Returns:
    
    The new matrix.
  - multiply
```
public Matrix multiply(double scalar)
```
    Creates a new matrix by multiplying this matrix by a scalar.
    
    Parameters:
    
    scalar - The scalar.
    
    Returns:
    
    The new matrix.
  - add
```
public Matrix add(double scalar)
```
    Creates a new matrix by adding each value in this matrix by a scalar.
    
    Parameters:
    
    scalar - The scalar.
    
    Returns:
    
    The new matrix.
  - abs
```
public Matrix abs()
```
    Creates a new matrix by taking the absolute value of this matrix.
    
    Returns:
    
    The new matrix.
  - sqrt
```
public Matrix sqrt()
```
    Creates a new matrix by taking the square root of this matrix.
    
    Returns:
    
    The new matrix.
  - isSameSize
```
public final boolean isSameSize(Matrix matrix)
```
    Determines if two this matrix and another matrix have the same dimensions.
    
    Parameters:
    
    matrix - The other matrix.
    
    Returns:
    
    true this matrix and the other matrix have the same dimensions.
  - isZeroMatrix
```
public final boolean isZeroMatrix()
```
    Determines if this matrix is a zero matrix.
    
    Returns:
    
    true if this matrix is a zero matrix.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - forEach
```
public void forEach(Matrix.ReadOnlyElementVisitorFunction func)
```
    Calls the specified function for every non-zero element.
    
    Parameters:
    
    func - The function.
  - create
```
protected abstract Matrix create(int numRows,
                                 int numCols)
```
    Creates a new matrix.
    
    Parameters:
    
    numRows - The number of rows.
    
    numCols - The number of columns.
    
    Returns:
    
    Created matrix.
  - getAtUnchecked
```
protected abstract double getAtUnchecked(int row,
                                         int col)
```
    Gets the value at the specified row and column.
    
    Parameters:
    
    row - The row.
    
    col - The column.
    
    Returns:
    
    The value.
  - setAtUnchecked
```
protected abstract void setAtUnchecked(int row,
                                       int col,
                                       double val)
```
    Sets a value at the specified row and column.
    
    Parameters:
    
    row - The row.
    
    col - The column.
    
    val - The value.
  - forEach
```
protected abstract void forEach(Matrix.ElementVisitorFunction func)
```
    Calls the specified function for every non-zero element.
    
    Parameters:
    
    func - The function.
  - getNonZeroElementRowIterator
```
public abstract MatrixNonZeroElementRowIterator getNonZeroElementRowIterator(int row)
```
    Gets the non-zero matrix row element iterator for a given row index.
    
    Parameters:
    
    row - The row index.
    
    Returns:
    
    The iterator.

Class Matrix

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Matrix

Method Detail

getElementCount

getRowCount

getColumnCount

getAt

setAt

incrementAt

getRowSumVector

getColumnSumVector

normalizeColumns

removeNegatives

removeLessThan

scale

multiplyElementWise

addElementWise

absSum

sum

multiply

transpose

roundTo

multiply

add

abs

sqrt

isSameSize

isZeroMatrix

hashCode

equals

forEach

create

getAtUnchecked

setAtUnchecked

forEach

getNonZeroElementRowIterator