smile.math.matrix

Class RowMajorMatrix

java.lang.Object

smile.math.matrix.RowMajorMatrix

All Implemented Interfaces:

DenseMatrix, Matrix, MatrixMultiplication<DenseMatrix,DenseMatrix>

public class RowMajorMatrix
extends java.lang.Object
implements DenseMatrix

A dense matrix whose data is stored in a single 1D array of doubles in row major order.

Constructor Summary

Constructors

Constructor and Description
RowMajorMatrix(double[] diag) Constructor of a square diagonal matrix with the elements of vector diag on the main diagonal.
RowMajorMatrix(double[][] A) Constructor.
RowMajorMatrix(int rows, int cols) Constructor of all-zero matrix.
RowMajorMatrix(int rows, int cols, double value) Constructor.
RowMajorMatrix(int rows, int cols, double[] value) Constructor.
RowMajorMatrix(int rows, int cols, double mu, double sigma) Constructor of matrix with normal random values with given mean and standard dev.

Method Summary

Modifier and Type	Method and Description
RowMajorMatrix	aat() Returns A * A'
RowMajorMatrix	abmm(DenseMatrix B) Returns the result of matrix multiplication A * B.
RowMajorMatrix	abtmm(DenseMatrix B) Returns the result of matrix multiplication A * B'.
RowMajorMatrix	add(double x) In place element-wise addition A = A + x
double	add(int i, int j, double x) A[i][j] += x
RowMajorMatrix	add(RowMajorMatrix b)
RowMajorMatrix	ata() Returns A' * A
RowMajorMatrix	atbmm(DenseMatrix B) Returns the result of matrix multiplication A' * B.
double[]	atx(double[] x, double[] y) y = A' * x
double[]	atxpy(double[] x, double[] y) y = A' * x + y
double[]	atxpy(double[] x, double[] y, double b) y = A' * x + b * y
double[]	ax(double[] x, double[] y) y = A * x
double[]	axpy(double[] x, double[] y) y = A * x + y
double[]	axpy(double[] x, double[] y, double b) y = A * x + b * y
RowMajorMatrix	copy() Returns a copy of this matrix.
RowMajorMatrix	div(double x) In place element-wise division A = A / x
double	div(int i, int j, double x) A[i][j] /= x
RowMajorMatrix	div(RowMajorMatrix b)
static RowMajorMatrix	eye(int n) Returns an n-by-n identity matrix with ones on the main diagonal and zeros elsewhere.
static RowMajorMatrix	eye(int m, int n) Returns an n-by-n identity matrix with ones on the main diagonal and zeros elsewhere.
double	get(int i, int j) Returns the entry value at row i and column j.
RowMajorMatrix	mul(double x) In place element-wise multiplication A = A * x
double	mul(int i, int j, double x) A[i][j] *= x
RowMajorMatrix	mul(RowMajorMatrix b)
int	ncols() Returns the number of columns.
int	nrows() Returns the number of rows.
RowMajorMatrix	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.
RowMajorMatrix	sub(double x) In place element-wise subtraction A = A - x
double	sub(int i, int j, double x) A[i][j] -= x
RowMajorMatrix	sub(RowMajorMatrix b)
double	sum() Returns the sum of all elements in the matrix.
java.lang.String	toString()
ColumnMajorMatrix	transpose() Returns the transpose that shares the same underlying array with this matrix.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface smile.math.matrix.DenseMatrix

add, add, add, array, div, div, div, inverse, inverse, mul, mul, mul, sub, sub, sub, toString, update

Methods inherited from interface smile.math.matrix.Matrix

apply, diag, trace

Constructor Detail

RowMajorMatrix

public RowMajorMatrix(double[][] A)

Constructor.

Parameters:

A - the array of matrix.

RowMajorMatrix

public RowMajorMatrix(int rows,
                      int cols)

Constructor of all-zero matrix.

RowMajorMatrix

public RowMajorMatrix(int rows,
                      int cols,
                      double value)

Constructor. Fill the matrix with given value.

RowMajorMatrix

public RowMajorMatrix(int rows,
                      int cols,
                      double[] value)

Constructor.

Parameters:

value - the array of matrix values arranged in row major format

RowMajorMatrix

public RowMajorMatrix(double[] diag)

Constructor of a square diagonal matrix with the elements of vector diag on the main diagonal.

RowMajorMatrix

public RowMajorMatrix(int rows,
                      int cols,
                      double mu,
                      double sigma)

Constructor of matrix with normal random values with given mean and standard dev.

Method Detail

eye

public static RowMajorMatrix eye(int n)

Returns an n-by-n identity matrix with ones on the main diagonal and zeros elsewhere.

eye

public static RowMajorMatrix eye(int m,
                                 int n)

Returns an n-by-n identity matrix with ones on the main diagonal and zeros elsewhere.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

copy

public RowMajorMatrix copy()

Description copied from interface: DenseMatrix

Returns a copy of this matrix.

Specified by:

copy in interface DenseMatrix

transpose

public ColumnMajorMatrix transpose()

Returns the transpose that shares the same underlying array with this matrix. The result matrix should only be used for read only operations, which is the typical cases in linear algebra.

Specified by:

transpose in interface DenseMatrix

Specified by:

transpose in interface Matrix

nrows

public int nrows()

Description copied from interface: Matrix

Returns the number of rows.

Specified by:

nrows in interface Matrix

ncols

public int ncols()

Description copied from interface: Matrix

Returns the number of columns.

Specified by:

ncols in interface Matrix

get

public double get(int i,
                  int j)

Description copied from interface: Matrix

Returns the entry value at row i and column j.

Specified by:

get in interface Matrix

set

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

Description copied from interface: DenseMatrix

Set the entry value at row i and column j.

Specified by:

set in interface DenseMatrix

add

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

Description copied from interface: DenseMatrix

A[i][j] += x

Specified by:

add in interface DenseMatrix

sub

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

Description copied from interface: DenseMatrix

A[i][j] -= x

Specified by:

sub in interface DenseMatrix

mul

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

Description copied from interface: DenseMatrix

A[i][j] *= x

Specified by:

mul in interface DenseMatrix

div

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

Description copied from interface: DenseMatrix

A[i][j] /= x

Specified by:

div in interface DenseMatrix

add

public RowMajorMatrix add(RowMajorMatrix b)

sub

public RowMajorMatrix sub(RowMajorMatrix b)

mul

public RowMajorMatrix mul(RowMajorMatrix b)

div

public RowMajorMatrix div(RowMajorMatrix b)

add

public RowMajorMatrix add(double x)

Description copied from interface: DenseMatrix

In place element-wise addition A = A + x

Specified by:

add in interface DenseMatrix

sub

public RowMajorMatrix sub(double x)

Description copied from interface: DenseMatrix

In place element-wise subtraction A = A - x

Specified by:

sub in interface DenseMatrix

mul

public RowMajorMatrix mul(double x)

Description copied from interface: DenseMatrix

In place element-wise multiplication A = A * x

Specified by:

mul in interface DenseMatrix

div

public RowMajorMatrix div(double x)

Description copied from interface: DenseMatrix

In place element-wise division A = A / x

Specified by:

div in interface DenseMatrix

replaceNaN

public RowMajorMatrix replaceNaN(double x)

Description copied from interface: DenseMatrix

Replaces NaN's with given value.

Specified by:

replaceNaN in interface DenseMatrix

sum

public double sum()

Description copied from interface: DenseMatrix

Returns the sum of all elements in the matrix.

Specified by:

sum in interface DenseMatrix

Returns:

the sum of all elements.

ata

public RowMajorMatrix ata()

Description copied from interface: Matrix

Returns A' * A

Specified by:

ata in interface DenseMatrix

Specified by:

ata in interface Matrix

aat

public RowMajorMatrix aat()

Description copied from interface: Matrix

Returns A * A'

Specified by:

aat in interface DenseMatrix

Specified by:

aat in interface Matrix

ax

public double[] ax(double[] x,
                   double[] y)

Description copied from interface: Matrix

y = A * x

Specified by:

ax in interface Matrix

Returns:

y

axpy

public double[] axpy(double[] x,
                     double[] y)

Description copied from interface: Matrix

y = A * x + y

Specified by:

axpy in interface Matrix

Returns:

y

axpy

public double[] axpy(double[] x,
                     double[] y,
                     double b)

Description copied from interface: Matrix

y = A * x + b * y

Specified by:

axpy in interface Matrix

Returns:

y

atx

public double[] atx(double[] x,
                    double[] y)

Description copied from interface: Matrix

y = A' * x

Specified by:

atx in interface Matrix

Returns:

y

atxpy

public double[] atxpy(double[] x,
                      double[] y)

Description copied from interface: Matrix

y = A' * x + y

Specified by:

atxpy in interface Matrix

Returns:

y

atxpy

public double[] atxpy(double[] x,
                      double[] y,
                      double b)

Description copied from interface: Matrix

y = A' * x + b * y

Specified by:

atxpy in interface Matrix

Returns:

y

abmm

public RowMajorMatrix abmm(DenseMatrix B)

Description copied from interface: MatrixMultiplication

Returns the result of matrix multiplication A * B.

Specified by:

abmm in interface MatrixMultiplication<DenseMatrix,DenseMatrix>

abtmm

public RowMajorMatrix abtmm(DenseMatrix B)

Description copied from interface: MatrixMultiplication

Returns the result of matrix multiplication A * B'.

Specified by:

abtmm in interface MatrixMultiplication<DenseMatrix,DenseMatrix>

atbmm

public RowMajorMatrix atbmm(DenseMatrix B)

Description copied from interface: MatrixMultiplication

Returns the result of matrix multiplication A' * B.

Specified by:

atbmm in interface MatrixMultiplication<DenseMatrix,DenseMatrix>