JMatrix

java.lang.Object
- smile.math.matrix.JMatrix

All Implemented Interfaces:

java.io.Serializable, DenseMatrix, Matrix, MatrixMultiplication<DenseMatrix,DenseMatrix>
```
public class JMatrix
extends java.lang.Object
implements DenseMatrix
```
A pure Java implementation of DenseMatrix whose data is stored in a single 1D array of doubles in column major order.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`JMatrix(double[] A)` Constructor of a column vector/matrix with given array as the internal storage.
`JMatrix(double[][] A)` Constructor.
`JMatrix(int rows, int cols)` Constructor of all-zero matrix.
`JMatrix(int rows, int cols, double value)` Constructor.
`JMatrix(int rows, int cols, double[] value)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JMatrix`	`aat()` Returns A * A'
`JMatrix`	`abmm(DenseMatrix B)` Returns the result of matrix multiplication A * B.
`JMatrix`	`abtmm(DenseMatrix B)` Returns the result of matrix multiplication A * B'.
`JMatrix`	`add(DenseMatrix b)` In place addition A = A + B
`DenseMatrix`	`add(DenseMatrix b, DenseMatrix c)` C = A + B
`JMatrix`	`add(double x)` In place element-wise addition A = A + x
`DenseMatrix`	`add(double x, DenseMatrix c)` Element-wise addition C = A + x
`JMatrix`	`add(double x, JMatrix c)`
`double`	`add(int i, int j, double x)` A[i][j] += x
`JMatrix`	`add(JMatrix b)`
`JMatrix`	`add(JMatrix b, JMatrix c)`
`JMatrix`	`ata()` Returns A' * A
`JMatrix`	`atbmm(DenseMatrix B)` Returns the result of matrix multiplication A' * B.
`JMatrix`	`atbtmm(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
`Cholesky`	`cholesky()` Cholesky decomposition for symmetric and positive definite matrix.
`JMatrix`	`copy()` Returns a copy of this matrix.
`double[]`	`data()` Returns the array that backs this matrix (optional operation).
`JMatrix`	`div(DenseMatrix b)` In place element-wise division A = A / B A = A - B
`DenseMatrix`	`div(DenseMatrix b, DenseMatrix c)` C = A / B
`JMatrix`	`div(double x)` In place element-wise division A = A / x
`DenseMatrix`	`div(double x, DenseMatrix c)` Element-wise addition C = A / x
`JMatrix`	`div(double x, JMatrix c)`
`double`	`div(int i, int j, double x)` A[i][j] /= x
`JMatrix`	`div(JMatrix b)`
`JMatrix`	`div(JMatrix b, JMatrix c)`
`double[]`	`eig()` Returns the eigen values in an array of size 2N.
`EVD`	`eigen()` Returns the eigen value decomposition.
`void`	`fill(double x)` Fill the matrix with a value.
`double`	`get(int i, int j)` Returns the entry value at row i and column j.
`boolean`	`isSymmetric()` Returns true if the matrix is symmetric.
`LU`	`lu()` LU decomposition is computed by a "left-looking", dot-product, Crout/Doolittle algorithm.
`JMatrix`	`mul(DenseMatrix b)` In place element-wise multiplication A = A * B
`DenseMatrix`	`mul(DenseMatrix b, DenseMatrix c)` C = A * B
`JMatrix`	`mul(double x)` In place element-wise multiplication A = A * x
`DenseMatrix`	`mul(double x, DenseMatrix c)` Element-wise addition C = A * x
`JMatrix`	`mul(double x, JMatrix c)`
`double`	`mul(int i, int j, double x)` A[i][j] *= x
`JMatrix`	`mul(JMatrix b)`
`JMatrix`	`mul(JMatrix b, JMatrix c)`
`int`	`ncols()` Returns the number of columns.
`int`	`nrows()` Returns the number of rows.
`QR`	`qr()` QR Decomposition is computed by Householder reflections.
`QR`	`qr(double tol)` QR Decomposition is computed by Householder reflections.
`JMatrix`	`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.
`void`	`setSymmetric(boolean symmetric)` Sets if the matrix is symmetric.
`protected static void`	`sort(double[] d, double[] e)` Sort eigenvalues.
`protected static void`	`sort(double[] d, double[] e, DenseMatrix V)` Sort eigenvalues and eigenvectors.
`JMatrix`	`sub(DenseMatrix b)` In place subtraction A = A - B
`DenseMatrix`	`sub(DenseMatrix b, DenseMatrix c)` C = A - B
`JMatrix`	`sub(double x)` In place element-wise subtraction A = A - x
`DenseMatrix`	`sub(double x, DenseMatrix c)` Element-wise addition C = A - x
`JMatrix`	`sub(double x, JMatrix c)`
`double`	`sub(int i, int j, double x)` A[i][j] -= x
`JMatrix`	`sub(JMatrix b)`
`JMatrix`	`sub(JMatrix b, JMatrix c)`
`double`	`sum()` Returns the sum of all elements in the matrix.
`SVD`	`svd()` Returns the singular value decomposition.
`java.lang.String`	`toString()`
`JMatrix`	`transpose()` Returns the matrix transpose.

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
apply, cholesky, colMeans, colSds, colSums, eig, eigen, inverse, inverse, ld, lu, norm, norm1, norm2, normFro, normInf, qr, rowMeans, rowSds, rowSums, scale, scale, submat, svd, toArray, update, xax

Methods inherited from interface smile.math.matrix.Matrix
apply, diag, diag, eigen, eigen, eye, eye, market, of, of, of, ones, randn, randn, svd, svd, toString, toString, trace, zeros

- Constructor Detail
  - JMatrix
```
public JMatrix(double[][] A)
```
    Constructor.
    
    Parameters:
    
    A - the array of matrix.
  - JMatrix
```
public JMatrix(double[] A)
```
    Constructor of a column vector/matrix with given array as the internal storage.
    
    Parameters:
    
    A - the array of column vector.
  - JMatrix
```
public JMatrix(int rows,
               int cols)
```
    Constructor of all-zero matrix.
  - JMatrix
```
public JMatrix(int rows,
               int cols,
               double value)
```
    Constructor. Fill the matrix with given value.
  - JMatrix
```
public JMatrix(int rows,
               int cols,
               double[] value)
```
    Constructor.
    
    Parameters:
    
    value - the array of matrix values arranged in column major format
- Method Detail
  - isSymmetric
```
public boolean isSymmetric()
```
    Description copied from interface: Matrix
    
    Returns true if the matrix is symmetric.
    
    Specified by:
    
    isSymmetric in interface Matrix
  - setSymmetric
```
public void setSymmetric(boolean symmetric)
```
    Description copied from interface: Matrix
    
    Sets if the matrix is symmetric. It is the caller's responability to make sure if the matrix symmetric. Also the matrix won't update this property if the matrix values are changed.
    
    Specified by:
    
    setSymmetric in interface Matrix
  - copy
```
public JMatrix copy()
```
    Description copied from interface: DenseMatrix
    
    Returns a copy of this matrix.
    
    Specified by:
    
    copy in interface DenseMatrix
  - data
```
public double[] data()
```
    Description copied from interface: DenseMatrix
    
    Returns the array that backs this matrix (optional operation).
    
    Specified by:
    
    data in interface DenseMatrix
  - fill
```
public void fill(double x)
```
    Description copied from interface: DenseMatrix
    
    Fill the matrix with a value.
    
    Specified by:
    
    fill in interface DenseMatrix
  - transpose
```
public JMatrix transpose()
```
    Description copied from interface: DenseMatrix
    
    Returns the matrix transpose.
    
    Specified by:
    
    transpose in interface DenseMatrix
    
    Specified by:
    
    transpose in interface Matrix
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - 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 JMatrix 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 JMatrix add(JMatrix 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 JMatrix add(JMatrix b,
                   JMatrix c)
```
  - sub
```
public JMatrix 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 JMatrix sub(JMatrix 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 JMatrix sub(JMatrix b,
                   JMatrix c)
```
  - mul
```
public JMatrix 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 JMatrix mul(JMatrix 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 JMatrix mul(JMatrix b,
                   JMatrix c)
```
  - div
```
public JMatrix 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 JMatrix div(JMatrix 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 JMatrix div(JMatrix b,
                   JMatrix c)
```
  - add
```
public JMatrix 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 JMatrix add(double x,
                   JMatrix c)
```
  - sub
```
public JMatrix 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 JMatrix sub(double x,
                   JMatrix c)
```
  - mul
```
public JMatrix 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 JMatrix mul(double x,
                   JMatrix c)
```
  - div
```
public JMatrix 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 JMatrix div(double x,
                   JMatrix c)
```
  - replaceNaN
```
public JMatrix 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 JMatrix ata()
```
    Description copied from interface: Matrix
    
    Returns A' * A
    
    Specified by:
    
    ata in interface DenseMatrix
    
    Specified by:
    
    ata in interface Matrix
  - aat
```
public JMatrix 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 JMatrix 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 JMatrix 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 JMatrix atbmm(DenseMatrix B)
```
    Description copied from interface: MatrixMultiplication
    
    Returns the result of matrix multiplication A' * B.
    
    Specified by:
    
    atbmm in interface MatrixMultiplication<DenseMatrix,DenseMatrix>
  - atbtmm
```
public JMatrix atbtmm(DenseMatrix B)
```
    Description copied from interface: MatrixMultiplication
    
    Returns the result of matrix multiplication A' * B'.
    
    Specified by:
    
    atbtmm in interface MatrixMultiplication<DenseMatrix,DenseMatrix>
  - lu
```
public LU lu()
```
    LU decomposition is computed by a "left-looking", dot-product, Crout/Doolittle algorithm.
    
    Specified by:
    
    lu in interface DenseMatrix
  - cholesky
```
public Cholesky cholesky()
```
    Cholesky decomposition for symmetric and positive definite matrix. Only the lower triangular part will be used in the decomposition.
    
    Specified by:
    
    cholesky in interface DenseMatrix
    
    Throws:
    
    java.lang.IllegalArgumentException - if the matrix is not positive definite.
  - qr
```
public QR qr()
```
    QR Decomposition is computed by Householder reflections.
    
    Specified by:
    
    qr in interface DenseMatrix
  - qr
```
public QR qr(double tol)
```
    QR Decomposition is computed by Householder reflections.
    
    Parameters:
    
    tol - the tolerance for detecting linear dependencies in the column vectors.
  - svd
```
public SVD svd()
```
    Description copied from interface: DenseMatrix
    
    Returns the singular value decomposition. Note that the input matrix will hold U on output.
    
    Specified by:
    
    svd in interface DenseMatrix
  - eig
```
public double[] eig()
```
    Description copied from interface: DenseMatrix
    
    Returns the eigen values in an array of size 2N. The first half and second half of returned array contain the real and imaginary parts, respectively, of the computed eigenvalues.
    
    Specified by:
    
    eig in interface DenseMatrix
  - eigen
```
public EVD eigen()
```
    Description copied from interface: DenseMatrix
    
    Returns the eigen value decomposition. Note that the input matrix will be overwritten on output.
    
    Specified by:
    
    eigen in interface DenseMatrix
  - sort
```
protected static void sort(double[] d,
                           double[] e)
```
    Sort eigenvalues.
  - sort
```
protected static void sort(double[] d,
                           double[] e,
                           DenseMatrix V)
```
    Sort eigenvalues and eigenvectors.

Class JMatrix

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface smile.math.matrix.DenseMatrix

Methods inherited from interface smile.math.matrix.Matrix

Constructor Detail

JMatrix

JMatrix

JMatrix

JMatrix

JMatrix

Method Detail

isSymmetric

setSymmetric

copy

data

fill

transpose

toString

nrows

ncols

get

set

add

sub

mul

div

add

add

add

add

sub

sub

sub

sub

mul

mul

mul

mul

div

div

div

div

add

add

add

sub

sub

sub

mul

mul

mul

div

div

div

replaceNaN

sum

ata

aat

ax

axpy

axpy

atx

atxpy

atxpy

abmm

abtmm

atbmm

atbtmm

lu

cholesky

qr

qr

svd

eig

eigen

sort

sort