Matrix

public class Matrix extends Tensor

Represents real matrix. Matrix class is a subclass of Tensor class.

Parameters

data

must fit into the shape of this matrix.

Constructors

Matrix

Matrix Matrix(Integer rows2, Integer cols2, LongArray data2)

data can be LongArray.

Matrix

Matrix Matrix(Integer rows2, Integer cols2, FloatArray data2)

data can be FloatArray.

Matrix

Matrix Matrix(Integer rows2, Integer cols2, IntArray data2)

data can be IntArray.

Matrix

Matrix Matrix(Integer rows2, Integer cols2, Function2<Integer, Integer, Number> lambda)

It is possible to set a value using lambda function.

Matrix

Matrix Matrix(Integer rows, Integer cols, DoubleArray data)

Creates a new matrix.

Types

Companion

public class Companion

Functions

addRow

final Matrix addRow(Integer srcRowIndex, Integer dstRowIndex, Number fraction)

Do a row addition transformation; add dstRow multiplied by fraction to srcRow.

adjoint

final Matrix adjoint()

Calculate adjoint matrix of this matrix.

columnWiseMean

final RowVector columnWiseMean()

Calculate the mean value of each column.

colVecNormSq

final RowVector colVecNormSq()

Calculate the squared norm of each column vector.

concat

final Matrix concat(Matrix other, Integer concatDim)

Concatenate to other matrix.

final Tensor concat(Tensor other, Integer concatDim)

Concatenate to other tensor.

copy

Matrix copy()

Same as Tensor.copy but returns Matrix

div

Matrix div(Number other)

eltwiseMul

final Matrix eltwiseMul(Matrix other)

Element-wise multiplication.

equals

Boolean equals(Object other)

flatten

final Tensor flatten()

Reshape to a 1-dimensional tensor.

frobeniusNormSquared

final Double frobeniusNormSquared()

Calculate squared frobenius norm.

get

final Double get(IntArray indices)

final Tensor get(Long indexLong)

final Double get(Integer rowIndex, Integer colIndex)

getCols

final Integer getCols()

number of columns.

getDim

final Integer getDim()

tensor dimension.

getRows

final Integer getRows()

number of rows.

getShape

final IntArray getShape()

tensor shape.

getSubmatrix

Matrix getSubmatrix(Integer rowIndexStart, Integer rowIndexEnd, Integer colIndexStart, Integer colIndexEnd)

Get a submatrix by slicing this matrix.

map

Matrix map(Function1<Double, Number> lambda)

Same as Tensor.map but returns Matrix.

minorMatrix

final Matrix minorMatrix(Integer rowIndex, Integer colIndex)

Get a minor matrix.

minus

final Matrix minus(Matrix other)

final Tensor minus(Tensor other)

plus

final Matrix plus(Matrix other)

final Tensor plus(Tensor other)

pow

final Matrix pow(Integer n)

Calculate the nth power of this matrix.

pseudoEquals

final Boolean pseudoEquals(Tensor other)

Determines if other is close enough to be said the same.

reshape

final Tensor reshape(IntArray newShape)

Reshape this tensor.

final Matrix reshape(Integer newRows, Integer newCols)

Reshape this matrix.

rowVecNormSq

final ColumnVector rowVecNormSq()

Calculate the squared norm of each row vector.

rowWiseMean

final ColumnVector rowWiseMean()

Calculate the mean value of each row.

set

final Unit set(IntArray indices, Number value)

final Unit set(Integer rowIndex, Integer colIndex, Number value)

setSubmatrix

Unit setSubmatrix(Integer rowIndexStart, Integer rowIndexEnd, Integer colIndexStart, Integer colIndexEnd, Matrix other)

Set a submatrix by substituting other to desired position.

sum

final Double sum()

Calculate the sum of all values in this matrix.

switchRow

final Matrix switchRow(Integer rowIndex1, Integer rowIndex2)

Do a row switching transformation; exchange rowIndex1th row and rowIndex2th row.

times

Matrix times(Number other)

final ColumnVector times(ColumnVector other)

Matrix times(Matrix other)

final Tensor times(Tensor other)

toColVector

final ColumnVector toColVector()

Downcast to ColumnVector class if possible; i.e.

toComplex

ComplexMatrix toComplex()

Same as Tensor.toComplex but returns ComplexMatrix.

toMatrix

final Matrix toMatrix()

Downcast to Matrix class, if possible: i.e.

toRowVector

final RowVector toRowVector()

Downcast to RowVector class if possible; i.e.

toString

String toString()

trace

final Double trace()

Calculate the trace of this matrix.

transpose

Matrix transpose()

Transpose this Matrix.

unaryMinus

Matrix unaryMinus()

unaryPlus

Matrix unaryPlus()

Properties

cols

private final Integer cols

number of columns.

dim

private final Integer dim

tensor dimension.

rows

private final Integer rows

number of rows.

shape

private final IntArray shape

tensor shape.

Inheritors

ColumnVector

RowVector

Extensions

determinant

final Double determinant()

Calculates a determiant using LU decomposition through recursion, O(n^3).

eig

final Array<ComplexMatrix> eig()

Solves eigenvalue problem of a square matrix and finds eigenvectors of each eigenvalue.

inverse

final Matrix inverse()

Calculates an inverse matrix of a square matrix.

plu

final Array<Matrix> plu()

PLU decomposition of a matrix.

final Array<Matrix> qr()

Calculates QR decomposition of square matrix.

rowEchelonForm

final Matrix rowEchelonForm()

Calculate reduced row echelon form using Gaussian elimination.

svd

final Array<ComplexMatrix> svd()

Calculate the singular value decomposition of a matrix.