xlinear

Interface Matrix

All Known Subinterfaces:

DenseMatrix, SparseMatrix

All Known Implementing Classes:

ColtSparseMatrix, CommonsDenseMatrix, Slice

public interface Matrix

Note: it is not recommended that the user implements this interface directly, since many operators depend on more detailed knowledge of the implementation for efficiency, in particular if the matrix is dense or sparse. So we assume at many places a finite number of direct sub-classes of this interface. TODO: add instructions on how to sub-class, by using DenseMatrix or SparseMatrix

Method Summary

Modifier and Type	Method and Description
DenseMatrix	add(DenseMatrix m)
default Matrix	add(Matrix m)
Matrix	add(SparseMatrix m)
void	addInPlace(DenseMatrix m)
default void	addInPlace(Matrix m)
void	addInPlace(SparseMatrix m)
CholeskyDecomposition	cholesky()
default Matrix	col(int index)
Matrix	createEmpty(int nRows, int nCols)
default Matrix	div(java.lang.Number n)
default void	divInPlace(java.lang.Number n)
default double	get(int index) If this matrix is a vector (either n by 1, or 1 by n), return the value at given index, otherwise, throw the StaticUtils::notAVectorException exception.
double	get(int row, int col)
Matrix	inverse()
default boolean	isVector()
LUDecomposition	lu()
DenseMatrix	mul(DenseMatrix m)
default Matrix	mul(Matrix m)
Matrix	mul(java.lang.Number n)
Matrix	mul(SparseMatrix m)
void	mulInPlace(java.lang.Number n)
int	nCols()
default int	nEntries()
java.util.stream.DoubleStream	nonZeroEntries()
int	nRows()
default void	operator_add(DenseMatrix m)
default void	operator_add(Matrix m)
default void	operator_add(SparseMatrix m)
default Matrix	operator_divide(java.lang.Number n)
default void	operator_divideAssign(java.lang.Number n)
DenseMatrix	operator_minus(DenseMatrix m)
Matrix	operator_minus(Matrix m)
Matrix	operator_minus(SparseMatrix m)
DenseMatrix	operator_multiply(DenseMatrix m)
Matrix	operator_multiply(Matrix m)
Matrix	operator_multiply(java.lang.Number n)
Matrix	operator_multiply(SparseMatrix m)
default void	operator_multiplyAssign(java.lang.Number n)
DenseMatrix	operator_plus(DenseMatrix m)
Matrix	operator_plus(Matrix m)
Matrix	operator_plus(SparseMatrix m)
default void	operator_remove(DenseMatrix m)
default void	operator_remove(Matrix m)
default void	operator_remove(SparseMatrix m)
default Matrix	readOnlyView()
default Matrix	row(int index)
default void	set(int index, double value)
void	set(int row, int col, double v)
default Matrix	slice(int row0Incl, int row1Excl, int col0Incl, int col1Excl)
Matrix	slice(int row0Incl, int row1Excl, int col0Incl, int col1Excl, boolean makeReadOnly)
DenseMatrix	sub(DenseMatrix m)
default Matrix	sub(Matrix m)
Matrix	sub(SparseMatrix m)
void	subInPlace(DenseMatrix m)
default void	subInPlace(Matrix m)
void	subInPlace(SparseMatrix m)
Matrix	transpose()

Method Detail

slice

Matrix slice(int row0Incl,
             int row1Excl,
             int col0Incl,
             int col1Excl,
             boolean makeReadOnly)

slice

default Matrix slice(int row0Incl,
                     int row1Excl,
                     int col0Incl,
                     int col1Excl)

row

default Matrix row(int index)

col

default Matrix col(int index)

readOnlyView

default Matrix readOnlyView()

nRows

int nRows()

nCols

int nCols()

nEntries

default int nEntries()

get

double get(int row,
           int col)

set

void set(int row,
         int col,
         double v)

nonZeroEntries

java.util.stream.DoubleStream nonZeroEntries()

get

default double get(int index)

If this matrix is a vector (either n by 1, or 1 by n), return the value at given index, otherwise, throw the StaticUtils::notAVectorException exception.

set

default void set(int index,
                 double value)

isVector

default boolean isVector()

createEmpty

Matrix createEmpty(int nRows,
                   int nCols)

cholesky

CholeskyDecomposition cholesky()

lu

LUDecomposition lu()

transpose

Matrix transpose()

inverse

Matrix inverse()

operator_multiply

Matrix operator_multiply(java.lang.Number n)

mul

Matrix mul(java.lang.Number n)

operator_divide

default Matrix operator_divide(java.lang.Number n)

div

default Matrix div(java.lang.Number n)

operator_multiplyAssign

default void operator_multiplyAssign(java.lang.Number n)

mulInPlace

void mulInPlace(java.lang.Number n)

operator_divideAssign

default void operator_divideAssign(java.lang.Number n)

divInPlace

default void divInPlace(java.lang.Number n)

operator_multiply

Matrix operator_multiply(Matrix m)

operator_multiply

DenseMatrix operator_multiply(DenseMatrix m)

operator_multiply

Matrix operator_multiply(SparseMatrix m)

mul

default Matrix mul(Matrix m)

mul

DenseMatrix mul(DenseMatrix m)

mul

Matrix mul(SparseMatrix m)

operator_plus

Matrix operator_plus(Matrix m)

operator_plus

DenseMatrix operator_plus(DenseMatrix m)

operator_plus

Matrix operator_plus(SparseMatrix m)

add

default Matrix add(Matrix m)

add

DenseMatrix add(DenseMatrix m)

add

Matrix add(SparseMatrix m)

operator_add

default void operator_add(Matrix m)

operator_add

default void operator_add(DenseMatrix m)

operator_add

default void operator_add(SparseMatrix m)

addInPlace

default void addInPlace(Matrix m)

addInPlace

void addInPlace(DenseMatrix m)

addInPlace

void addInPlace(SparseMatrix m)

operator_minus

Matrix operator_minus(Matrix m)

operator_minus

DenseMatrix operator_minus(DenseMatrix m)

operator_minus

Matrix operator_minus(SparseMatrix m)

sub

default Matrix sub(Matrix m)

sub

DenseMatrix sub(DenseMatrix m)

sub

Matrix sub(SparseMatrix m)

operator_remove

default void operator_remove(Matrix m)

operator_remove

default void operator_remove(DenseMatrix m)

operator_remove

default void operator_remove(SparseMatrix m)

subInPlace

default void subInPlace(Matrix m)

subInPlace

void subInPlace(DenseMatrix m)

subInPlace

void subInPlace(SparseMatrix m)