smile.math.matrix

Class ColumnMajorMatrix

java.lang.Object

smile.math.matrix.ColumnMajorMatrix

All Implemented Interfaces:

DenseMatrix, Matrix, MatrixMultiplication<DenseMatrix,DenseMatrix>

public class ColumnMajorMatrix
extends java.lang.Object
implements DenseMatrix

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

Constructor Summary

Constructors

Constructor and Description
ColumnMajorMatrix(double[] diag) Constructor of a square diagonal matrix with the elements of vector diag on the main diagonal.
ColumnMajorMatrix(double[][] A) Constructor.
ColumnMajorMatrix(int rows, int cols) Constructor of all-zero matrix.
ColumnMajorMatrix(int rows, int cols, double value) Constructor.
ColumnMajorMatrix(int rows, int cols, double[] value) Constructor.
ColumnMajorMatrix(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
ColumnMajorMatrix	aat() Returns A * A'
ColumnMajorMatrix	abmm(DenseMatrix B) Returns the result of matrix multiplication A * B.
ColumnMajorMatrix	abtmm(DenseMatrix B) Returns the result of matrix multiplication A * B'.
ColumnMajorMatrix	add(ColumnMajorMatrix b)
ColumnMajorMatrix	add(ColumnMajorMatrix b, ColumnMajorMatrix c)
ColumnMajorMatrix	add(DenseMatrix b) In place addition A = A + B
DenseMatrix	add(DenseMatrix b, DenseMatrix c) C = A + B
ColumnMajorMatrix	add(double x) In place element-wise addition A = A + x
ColumnMajorMatrix	add(double x, ColumnMajorMatrix c)
DenseMatrix	add(double x, DenseMatrix c) Element-wise addition C = A + x
double	add(int i, int j, double x) A[i][j] += x
ColumnMajorMatrix	ata() Returns A' * A
ColumnMajorMatrix	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
ColumnMajorMatrix	copy() Returns a copy of this matrix.
ColumnMajorMatrix	div(ColumnMajorMatrix b)
ColumnMajorMatrix	div(ColumnMajorMatrix b, ColumnMajorMatrix c)
ColumnMajorMatrix	div(DenseMatrix b) In place element-wise division A = A / B A = A - B
DenseMatrix	div(DenseMatrix b, DenseMatrix c) C = A / B
ColumnMajorMatrix	div(double x) In place element-wise division A = A / x
ColumnMajorMatrix	div(double x, ColumnMajorMatrix c)
DenseMatrix	div(double x, DenseMatrix c) Element-wise addition C = A / x
double	div(int i, int j, double x) A[i][j] /= x
static ColumnMajorMatrix	eye(int n) Returns an n-by-n identity matrix with ones on the main diagonal and zeros elsewhere.
static ColumnMajorMatrix	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.
ColumnMajorMatrix	mul(ColumnMajorMatrix b)
ColumnMajorMatrix	mul(ColumnMajorMatrix b, ColumnMajorMatrix c)
ColumnMajorMatrix	mul(DenseMatrix b) In place element-wise multiplication A = A * B
DenseMatrix	mul(DenseMatrix b, DenseMatrix c) C = A * B
ColumnMajorMatrix	mul(double x) In place element-wise multiplication A = A * x
ColumnMajorMatrix	mul(double x, ColumnMajorMatrix c)
DenseMatrix	mul(double x, DenseMatrix c) Element-wise addition C = A * x
double	mul(int i, int j, double x) A[i][j] *= x
int	ncols() Returns the number of columns.
int	nrows() Returns the number of rows.
ColumnMajorMatrix	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.
ColumnMajorMatrix	sub(ColumnMajorMatrix b)
ColumnMajorMatrix	sub(ColumnMajorMatrix b, ColumnMajorMatrix c)
ColumnMajorMatrix	sub(DenseMatrix b) In place subtraction A = A - B
DenseMatrix	sub(DenseMatrix b, DenseMatrix c) C = A - B
ColumnMajorMatrix	sub(double x) In place element-wise subtraction A = A - x
ColumnMajorMatrix	sub(double x, ColumnMajorMatrix c)
DenseMatrix	sub(double x, DenseMatrix c) Element-wise addition C = A - x
double	sub(int i, int j, double x) A[i][j] -= x
double	sum() Returns the sum of all elements in the matrix.
java.lang.String	toString()
RowMajorMatrix	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

array, inverse, inverse, toString, update

Methods inherited from interface smile.math.matrix.Matrix

apply, diag, trace

Constructor Detail

ColumnMajorMatrix

public ColumnMajorMatrix(double[][] A)

Constructor.

Parameters:

A - the array of matrix.

ColumnMajorMatrix

public ColumnMajorMatrix(int rows,
                         int cols)

Constructor of all-zero matrix.

ColumnMajorMatrix

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

Constructor. Fill the matrix with given value.

ColumnMajorMatrix

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

Constructor.

Parameters:

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

ColumnMajorMatrix

public ColumnMajorMatrix(double[] diag)

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

ColumnMajorMatrix

public ColumnMajorMatrix(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 ColumnMajorMatrix eye(int n)

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

eye

public static ColumnMajorMatrix 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 ColumnMajorMatrix copy()

Description copied from interface: DenseMatrix

Returns a copy of this matrix.

Specified by:

copy in interface DenseMatrix

transpose

public RowMajorMatrix 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 ColumnMajorMatrix add(DenseMatrix b)

Description copied from interface: DenseMatrix

In place addition A = A + B

Specified by:

add in interface DenseMatrix

Returns:

this matrix

add

public ColumnMajorMatrix add(ColumnMajorMatrix b)

add

public DenseMatrix add(DenseMatrix b,
                       DenseMatrix c)

Description copied from interface: DenseMatrix

C = A + B

Specified by:

add in interface DenseMatrix

Returns:

the result matrix

add

public ColumnMajorMatrix add(ColumnMajorMatrix b,
                             ColumnMajorMatrix c)

sub

public ColumnMajorMatrix sub(DenseMatrix b)

Description copied from interface: DenseMatrix

In place subtraction A = A - B

Specified by:

sub in interface DenseMatrix

Returns:

this matrix

sub

public ColumnMajorMatrix sub(ColumnMajorMatrix b)

sub

public DenseMatrix sub(DenseMatrix b,
                       DenseMatrix c)

Description copied from interface: DenseMatrix

C = A - B

Specified by:

sub in interface DenseMatrix

Returns:

the result matrix

sub

public ColumnMajorMatrix sub(ColumnMajorMatrix b,
                             ColumnMajorMatrix c)

mul

public ColumnMajorMatrix mul(DenseMatrix b)

Description copied from interface: DenseMatrix

In place element-wise multiplication A = A * B

Specified by:

mul in interface DenseMatrix

Returns:

this matrix

mul

public ColumnMajorMatrix mul(ColumnMajorMatrix b)

mul

public DenseMatrix mul(DenseMatrix b,
                       DenseMatrix c)

Description copied from interface: DenseMatrix

C = A * B

Specified by:

mul in interface DenseMatrix

Returns:

the result matrix

mul

public ColumnMajorMatrix mul(ColumnMajorMatrix b,
                             ColumnMajorMatrix c)

div

public ColumnMajorMatrix div(DenseMatrix b)

Description copied from interface: DenseMatrix

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

Specified by:

div in interface DenseMatrix

Returns:

this matrix

div

public ColumnMajorMatrix div(ColumnMajorMatrix b)

div

public DenseMatrix div(DenseMatrix b,
                       DenseMatrix c)

Description copied from interface: DenseMatrix

C = A / B

Specified by:

div in interface DenseMatrix

Returns:

the result matrix

div

public ColumnMajorMatrix div(ColumnMajorMatrix b,
                             ColumnMajorMatrix c)

add

public ColumnMajorMatrix add(double x)

Description copied from interface: DenseMatrix

In place element-wise addition A = A + x

Specified by:

add in interface DenseMatrix

add

public DenseMatrix add(double x,
                       DenseMatrix c)

Description copied from interface: DenseMatrix

Element-wise addition C = A + x

Specified by:

add in interface DenseMatrix

add

public ColumnMajorMatrix add(double x,
                             ColumnMajorMatrix c)

sub

public ColumnMajorMatrix sub(double x)

Description copied from interface: DenseMatrix

In place element-wise subtraction A = A - x

Specified by:

sub in interface DenseMatrix

sub

public DenseMatrix sub(double x,
                       DenseMatrix c)

Description copied from interface: DenseMatrix

Element-wise addition C = A - x

Specified by:

sub in interface DenseMatrix

sub

public ColumnMajorMatrix sub(double x,
                             ColumnMajorMatrix c)

mul

public ColumnMajorMatrix mul(double x)

Description copied from interface: DenseMatrix

In place element-wise multiplication A = A * x

Specified by:

mul in interface DenseMatrix

mul

public DenseMatrix mul(double x,
                       DenseMatrix c)

Description copied from interface: DenseMatrix

Element-wise addition C = A * x

Specified by:

mul in interface DenseMatrix

mul

public ColumnMajorMatrix mul(double x,
                             ColumnMajorMatrix c)

div

public ColumnMajorMatrix div(double x)

Description copied from interface: DenseMatrix

In place element-wise division A = A / x

Specified by:

div in interface DenseMatrix

div

public DenseMatrix div(double x,
                       DenseMatrix c)

Description copied from interface: DenseMatrix

Element-wise addition C = A / x

Specified by:

div in interface DenseMatrix

div

public ColumnMajorMatrix div(double x,
                             ColumnMajorMatrix c)

replaceNaN

public ColumnMajorMatrix 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 ColumnMajorMatrix ata()

Description copied from interface: Matrix

Returns A' * A

Specified by:

ata in interface DenseMatrix

Specified by:

ata in interface Matrix

aat

public ColumnMajorMatrix 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 ColumnMajorMatrix 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 ColumnMajorMatrix 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 ColumnMajorMatrix atbmm(DenseMatrix B)

Description copied from interface: MatrixMultiplication

Returns the result of matrix multiplication A' * B.

Specified by:

atbmm in interface MatrixMultiplication<DenseMatrix,DenseMatrix>