smile.math.matrix

Interface DenseMatrix

All Superinterfaces:

Matrix, MatrixMultiplication<DenseMatrix,DenseMatrix>

All Known Implementing Classes:

ColumnMajorMatrix, NaiveMatrix, RowMajorMatrix

public interface DenseMatrix
extends Matrix, MatrixMultiplication<DenseMatrix,DenseMatrix>

An abstract interface of dense matrix.

Method Summary

Modifier and Type	Method and Description
DenseMatrix	aat() Returns A * A'
default DenseMatrix	add(DenseMatrix b) In place addition A = A + B
default DenseMatrix	add(DenseMatrix b, DenseMatrix c) C = A + B
default DenseMatrix	add(double x) In place element-wise addition A = A + x
default DenseMatrix	add(double x, DenseMatrix c) Element-wise addition C = A + x
double	add(int i, int j, double x) A[i][j] += x
default double[][]	array() Return the two-dimensional array of matrix.
DenseMatrix	ata() Returns A' * A
DenseMatrix	copy() Returns a copy of this matrix.
default DenseMatrix	div(DenseMatrix b) In place element-wise division A = A / B A = A - B
default DenseMatrix	div(DenseMatrix b, DenseMatrix c) C = A / B
default DenseMatrix	div(double x) In place element-wise division A = A / x
default DenseMatrix	div(double x, DenseMatrix c) Element-wise addition C = A / x
double	div(int i, int j, double x) A[i][j] /= x
default DenseMatrix	inverse() Returns the inverse matrix.
default DenseMatrix	inverse(boolean inPlace) Returns the inverse matrix.
default DenseMatrix	mul(DenseMatrix b) In place element-wise multiplication A = A * B
default DenseMatrix	mul(DenseMatrix b, DenseMatrix c) C = A * B
default DenseMatrix	mul(double x) In place element-wise multiplication A = A * x
default DenseMatrix	mul(double x, DenseMatrix c) Element-wise addition C = A * x
double	mul(int i, int j, double x) A[i][j] *= x
default DenseMatrix	replaceNaN(double x) Replaces NaN's with given value.
double	set(int i, int j, double x) Set the entry value at row i and column j.
default DenseMatrix	sub(DenseMatrix b) In place subtraction A = A - B
default DenseMatrix	sub(DenseMatrix b, DenseMatrix c) C = A - B
default DenseMatrix	sub(double x) In place element-wise subtraction A = A - x
default DenseMatrix	sub(double x, DenseMatrix c) Element-wise addition C = A - x
double	sub(int i, int j, double x) A[i][j] -= x
default double	sum() Returns the sum of all elements in the matrix.
default java.lang.String	toString(boolean full) Returns the string representation of matrix.
DenseMatrix	transpose() Returns the matrix transpose.
default double	update(int i, int j, double x) Set the entry value at row i and column j.

Methods inherited from interface smile.math.matrix.Matrix

apply, atx, atxpy, atxpy, ax, axpy, axpy, diag, get, ncols, nrows, trace

Methods inherited from interface smile.math.matrix.MatrixMultiplication

abmm, abtmm, atbmm

Method Detail

set

double set(int i,
           int j,
           double x)

Set the entry value at row i and column j.

update

default double update(int i,
                      int j,
                      double x)

Set the entry value at row i and column j. For Scala users.

transpose

DenseMatrix transpose()

Returns the matrix transpose.

Specified by:

transpose in interface Matrix

inverse

default DenseMatrix inverse()

Returns the inverse matrix.

inverse

default DenseMatrix inverse(boolean inPlace)

Returns the inverse matrix.

Parameters:

inPlace - if true, this matrix will be used for matrix decomposition.

copy

DenseMatrix copy()

Returns a copy of this matrix.

ata

DenseMatrix ata()

Description copied from interface: Matrix

Returns A' * A

Specified by:

ata in interface Matrix

aat

DenseMatrix aat()

Description copied from interface: Matrix

Returns A * A'

Specified by:

aat in interface Matrix

add

double add(int i,
           int j,
           double x)

A[i][j] += x

sub

double sub(int i,
           int j,
           double x)

A[i][j] -= x

mul

double mul(int i,
           int j,
           double x)

A[i][j] *= x

div

double div(int i,
           int j,
           double x)

A[i][j] /= x

add

default DenseMatrix add(DenseMatrix b,
                        DenseMatrix c)

C = A + B

Returns:

the result matrix

add

default DenseMatrix add(DenseMatrix b)

In place addition A = A + B

Returns:

this matrix

sub

default DenseMatrix sub(DenseMatrix b,
                        DenseMatrix c)

C = A - B

Returns:

the result matrix

sub

default DenseMatrix sub(DenseMatrix b)

In place subtraction A = A - B

Returns:

this matrix

mul

default DenseMatrix mul(DenseMatrix b,
                        DenseMatrix c)

C = A * B

Returns:

the result matrix

mul

default DenseMatrix mul(DenseMatrix b)

In place element-wise multiplication A = A * B

Returns:

this matrix

div

default DenseMatrix div(DenseMatrix b,
                        DenseMatrix c)

C = A / B

Returns:

the result matrix

div

default DenseMatrix div(DenseMatrix b)

In place element-wise division A = A / B A = A - B

Returns:

this matrix

add

default DenseMatrix add(double x,
                        DenseMatrix c)

Element-wise addition C = A + x

add

default DenseMatrix add(double x)

In place element-wise addition A = A + x

sub

default DenseMatrix sub(double x,
                        DenseMatrix c)

Element-wise addition C = A - x

sub

default DenseMatrix sub(double x)

In place element-wise subtraction A = A - x

mul

default DenseMatrix mul(double x,
                        DenseMatrix c)

Element-wise addition C = A * x

mul

default DenseMatrix mul(double x)

In place element-wise multiplication A = A * x

div

default DenseMatrix div(double x,
                        DenseMatrix c)

Element-wise addition C = A / x

div

default DenseMatrix div(double x)

In place element-wise division A = A / x

replaceNaN

default DenseMatrix replaceNaN(double x)

Replaces NaN's with given value.

sum

default double sum()

Returns the sum of all elements in the matrix.

Returns:

the sum of all elements.

array

default double[][] array()

Return the two-dimensional array of matrix.

Returns:

the two-dimensional array of matrix.

toString

default java.lang.String toString(boolean full)

Returns the string representation of matrix.

Parameters:

full - Print the full matrix if true. Otherwise only print top left 7 x 7 submatrix.