IMatrix (Vectorz 0.62.0 API)

All Superinterfaces:

Cloneable, INDArray, Serializable

All Known Subinterfaces:

IFastColumns, IFastRows

All Known Implementing Classes:

AArrayMatrix, ABandedMatrix, ABlockMatrix, ABooleanMatrix, ADenseArrayMatrix, ADiagonalMatrix, AMatrix, APrimitiveMatrix, ARectangularMatrix, ASingleBandMatrix, ASparseRCMatrix, AStridedMatrix, ATriangularMatrix, AVectorMatrix, BandedMatrix, BaseStridedMatrix, BlockDiagonalMatrix, BroadcastVectorMatrix, BufferMatrix, ColumnMatrix, DenseColumnMatrix, DiagonalMatrix, IdentityMatrix, ImmutableMatrix, LowerTriangularMatrix, Matrix, Matrix11, Matrix22, Matrix33, MatrixBuilder, PermutationMatrix, PermutedMatrix, QuadtreeMatrix, RowMatrix, ScalarMatrix, SparseColumnMatrix, SparseRowMatrix, StridedMatrix, StridedRowMatrix, SubMatrixView, TransposedMatrix, UpperTriangularMatrix, VectorMatrixM3, VectorMatrixMN, ZeroMatrix
```
public interface IMatrix
extends INDArray
```
Interface for matrix operations. Matrix implementations should generally extend AMatrix which contains important functionality implementations, and serves as an abstract base class for matrices.

Author:

Mike

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`add2(AMatrix a, AMatrix b)` Adds two matrices to this matrix.
`void`	`addAt(int i, int j, double d)` Adds a value at a specific position in the matrix, mutating the matrix Does not perform bounds checking - this in an unsafe operation
`AMatrix`	`addCopy(AMatrix a)` Adds another matrix to this matrix, returning a new matrix
`AMatrix`	`addCopy(AVector v)` Adds a vector to every row of this matrix, returning a new matrix
`int`	`columnCount()` Gets the number of columns in this matrix (dimension 1)
`double`	`diagonalProduct()` Returns the product of all elements on the leading diagonal of this matrix
`double`	`get(int row, int column)` Gets the element at the specified position in this matrix
`AVector`	`getBand(int band)` Gets a band of a matrix The band is defined such that: - 0 is the main diagonal - bands above the main diagonal are 1, 2, 3 etc.
`AVector`	`getColumn(int column)` Returns a column of the matrix.
`AVector`	`getColumnClone(int column)` Returns a column of the matrix as a new cloned, mutable vector The cloned column may be modified without affecting the original matrix.
`List<AVector>`	`getColumns()` Gets a List of columns of a matrix.
`AVector`	`getColumnView(int column)` Returns a column of the matrix as a vector view.
`AVector`	`getRow(int row)` Returns a row of the matrix.
`AVector`	`getRowClone(int row)` Returns a row of the matrix as a new cloned, mutable vector.
`List<AVector>`	`getRows()` Gets a List of rows of a matrix.
`AVector`	`getRowView(int row)` Returns a row of the matrix as a vector view.
`AMatrix`	`getTranspose()` Returns the transpose of this matrix.
`AMatrix`	`getTransposeView()` Returns a transposed view of this matrix.
`AMatrix`	`innerProduct(AMatrix a)` Computes the inner product of this matrix with another.
`AVector`	`innerProduct(AVector source)` Transforms a source vector into a using matrix multiplication (inner product).
`Vector`	`innerProduct(Vector source)` Transforms a dense source Vector using matrix multiplication (inner product).
`AMatrix`	`inverse()` Computes the inverse of this matrix.
`boolean`	`isDiagonal()` Returns true iff this matrix is a square diagonal matrix
`boolean`	`isIdentity()` Checks if this is an identity matrix (i.e.
`boolean`	`isInvertible()` Checks if this is an invertible matrix (i.e.
`boolean`	`isRectangularDiagonal()` Returns true iff this matrix is a diagonal matrix (might not be square)
`boolean`	`isSquare()` Checks if this is a square matrix
`boolean`	`isSymmetric()` Returns true if this matrix is symmetric
`int`	`rowCount()` Gets the number of rows in this matrix (dimension 0)
`void`	`set(int row, int column, double value)` Sets the element at the specified position in this matrix
`AMatrix`	`subMatrix(int rowStart, int rows, int colStart, int cols)` Gets a rectangular submatrix view of part of a matrix
`double[][]`	`toNestedDoubleArrays()` Converts this matrix to nested double[][] array
`double`	`trace()` Computes the trace of a matrix, i.e.
`void`	`transform(AVector source, AVector dest)` Transforms a source vector into a destination vector, using matrix multiplication (inner product).
`void`	`transformInPlace(AVector v)`
`void`	`transposeInPlace()` Transposes a matrix in place, if possible.

Methods inherited from interface mikera.arrayz.INDArray
abs, absCopy, add, add, addAt, addCopy, addCopy, addInnerProduct, addMultiple, addOuterProduct, addPower, addPower, addToArray, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, broadcastLike, checkMutable, clamp, clone, componentCount, copy, dense, denseClone, dimensionality, divide, divide, divideCopy, elementAbsPowSum, elementCount, elementIterator, elementMax, elementMin, elementPowSum, elementProduct, elementsEqual, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, equals, equalsArray, equalsArray, exactClone, exp, fill, get, get, get, get, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, getElements, getLongShape, getShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, getTransposeCopy, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, isBoolean, isDense, isElementConstrained, isFullyMutable, isMutable, isSameShape, isSparse, isView, isZero, join, join, log, multiply, multiply, multiplyCopy, multiplyCopy, mutable, negate, negateCopy, nonZeroCount, outerProduct, pow, reciprocal, reciprocalCopy, reduce, reduce, reduceSlices, reduceSlices, reorder, reorder, reshape, rotateView, scale, scaleAdd, scaleAdd, scaleCopy, set, set, set, set, set, set, setElements, setElements, setElements, setInnerProduct, setMultiple, setMultiple, signum, signumCopy, slice, slice, sliceCount, sliceValue, sparse, sparseClone, sqrt, square, squareCopy, sub, sub, subArray, subCopy, toArray, toDoubleArray, toDoubleBuffer, toSliceArray, toVector, validate, withComponents

- Method Detail
  - rowCount
```
int rowCount()
```
    Gets the number of rows in this matrix (dimension 0)
    
    Returns:
  - columnCount
```
int columnCount()
```
    Gets the number of columns in this matrix (dimension 1)
    
    Returns:
  - get
```
double get(int row,
           int column)
```
    Gets the element at the specified position in this matrix
    
    Specified by:
    
    get in interface INDArray
    
    Returns:
  - set
```
void set(int row,
         int column,
         double value)
```
    Sets the element at the specified position in this matrix
    
    Specified by:
    
    set in interface INDArray
  - getRow
```
AVector getRow(int row)
```
    Returns a row of the matrix. May or may not be a view, depending on matrix type. Intended for the fastest possible read access of the row. This often means a view, but might not be (e.g. getRow on a Matrix33 returns a Vector3).
  - getColumn
```
AVector getColumn(int column)
```
    Returns a column of the matrix. May or may not be a view, depending on matrix type. Intended for the fastest possible read access of the column. This often means a view, but might not be (e.g. getColumn on a Matrix33 returns a Vector3).
  - getRowView
```
AVector getRowView(int row)
```
    Returns a row of the matrix as a vector view. May be used to modify the original matrix.
  - getColumnView
```
AVector getColumnView(int column)
```
    Returns a column of the matrix as a vector view. May be used to modify the original matrix.
  - getRowClone
```
AVector getRowClone(int row)
```
    Returns a row of the matrix as a new cloned, mutable vector. The cloned row may be modified without affecting the original matrix.
  - getColumnClone
```
AVector getColumnClone(int column)
```
    Returns a column of the matrix as a new cloned, mutable vector The cloned column may be modified without affecting the original matrix.
  - getBand
```
AVector getBand(int band)
```
    Gets a band of a matrix The band is defined such that: - 0 is the main diagonal - bands above the main diagonal are 1, 2, 3 etc. - bands below the main diagonal are -1, -2, -3 etc.
    
    Parameters:
    
    band -
    
    Returns:
  - getTranspose
```
AMatrix getTranspose()
```
    Returns the transpose of this matrix. Will be a transposed view by default, but specialised matrix type may override this if they are able to provide a better implementation.
    
    Specified by:
    
    getTranspose in interface INDArray
    
    Returns:
    
    the transpose of this matrix
  - getTransposeView
```
AMatrix getTransposeView()
```
    Returns a transposed view of this matrix.
    
    Specified by:
    
    getTransposeView in interface INDArray
    
    Returns:
    
    the transpose of this matrix, as a view
  - transposeInPlace
```
void transposeInPlace()
```
    Transposes a matrix in place, if possible. Throws an exception if this is not possible (e.g. if the matrix is not square or not sufficiently mutable)
  - isSquare
```
boolean isSquare()
```
    Checks if this is a square matrix
    
    Returns:
    
    true if square, false otherwise
  - isInvertible
```
boolean isInvertible()
```
    Checks if this is an invertible matrix (i.e. a square matrix with a non-zero determinant)
    
    Returns:
    
    true if invertible, false otherwise
  - isIdentity
```
boolean isIdentity()
```
    Checks if this is an identity matrix (i.e. 1.0 in leading diagonal, 0.0 elsewhere)
    
    Returns:
    
    true if this matrix is a square identity matrix, false otherwise.
  - innerProduct
```
AVector innerProduct(AVector source)
```
    Transforms a source vector into a using matrix multiplication (inner product).
    
    Specified by:
    
    innerProduct in interface INDArray
    
    Parameters:
    
    source - A vector
    
    Returns:
    
    A new vector
  - innerProduct
```
Vector innerProduct(Vector source)
```
    Transforms a dense source Vector using matrix multiplication (inner product).
    
    Returns:
    
    A new dense vector
  - transform
```
void transform(AVector source,
               AVector dest)
```
    Transforms a source vector into a destination vector, using matrix multiplication (inner product). The destination vector is overwritten.
  - transformInPlace
```
void transformInPlace(AVector v)
```
  - inverse
```
AMatrix inverse()
```
    Computes the inverse of this matrix.
    
    Returns:
    
    A matrix which is the inverse of this matrix, or null if the inverse does not exist.
  - trace
```
double trace()
```
    Computes the trace of a matrix, i.e. the sum of all elements on the leading diagonal
    
    Returns:
  - addCopy
```
AMatrix addCopy(AMatrix a)
```
    Adds another matrix to this matrix, returning a new matrix
    
    Parameters:
    
    v -
    
    Returns:
  - addCopy
```
AMatrix addCopy(AVector v)
```
    Adds a vector to every row of this matrix, returning a new matrix
    
    Parameters:
    
    v -
    
    Returns:
  - diagonalProduct
```
double diagonalProduct()
```
    Returns the product of all elements on the leading diagonal of this matrix
    
    Returns:
  - innerProduct
```
AMatrix innerProduct(AMatrix a)
```
    Computes the inner product of this matrix with another. Equivalent to matrix x matrix multiplication
    
    Parameters:
    
    a -
    
    Returns:
  - getRows
```
List<AVector> getRows()
```
    Gets a List of rows of a matrix. May return either copies or views, depending on the specific matrix type.
    
    Returns:
  - getColumns
```
List<AVector> getColumns()
```
    Gets a List of columns of a matrix. May return either copies or views, depending on the specific matrix type.
    
    Returns:
  - isSymmetric
```
boolean isSymmetric()
```
    Returns true if this matrix is symmetric
    
    Returns:
  - add2
```
void add2(AMatrix a,
          AMatrix b)
```
    Adds two matrices to this matrix. May be better optimised than adding both matrices individually.
    
    Parameters:
    
    a -
    
    b -
  - isDiagonal
```
boolean isDiagonal()
```
    Returns true iff this matrix is a square diagonal matrix
  - isRectangularDiagonal
```
boolean isRectangularDiagonal()
```
    Returns true iff this matrix is a diagonal matrix (might not be square)
  - toNestedDoubleArrays
```
double[][] toNestedDoubleArrays()
```
    Converts this matrix to nested double[][] array
    
    Returns:
  - subMatrix
```
AMatrix subMatrix(int rowStart,
                  int rows,
                  int colStart,
                  int cols)
```
    Gets a rectangular submatrix view of part of a matrix
  - addAt
```
void addAt(int i,
           int j,
           double d)
```
    Adds a value at a specific position in the matrix, mutating the matrix Does not perform bounds checking - this in an unsafe operation

Interface IMatrix

Method Summary

Methods inherited from interface mikera.arrayz.INDArray

Method Detail

rowCount

columnCount

get

set

getRow

getColumn

getRowView

getColumnView

getRowClone

getColumnClone

getBand

getTranspose

getTransposeView

transposeInPlace

isSquare

isInvertible

isIdentity

innerProduct

innerProduct

transform

transformInPlace

inverse

trace

addCopy

addCopy

diagonalProduct

innerProduct

getRows

getColumns

isSymmetric

add2

isDiagonal

isRectangularDiagonal

toNestedDoubleArrays

subMatrix

addAt