smile.math.matrix

Class DMatrix

java.lang.Object

smile.math.matrix.IMatrix<double[]>

smile.math.matrix.DMatrix

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

BandMatrix, Matrix, SparseMatrix, SymmMatrix

public abstract class DMatrix
extends IMatrix<double[]>

Double precision matrix base class.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DMatrix()

Method Summary

Modifier and Type	Method and Description
double	apply(int i, int j) Returns A[i, j] for Scala users.
double[]	diag() Returns the diagonal elements.
abstract double	get(int i, int j) Returns A[i, j].
static DMatrix	market(java.nio.file.Path path) Reads a matrix from a Matrix Market File Format file.
double[]	mv(double[] x) Returns the matrix-vector multiplication A * x.
void	mv(double[] x, double[] y) Matrix-vector multiplication y = A * x.
void	mv(double alpha, double[] x, double beta, double[] y) Matrix-vector multiplication.
abstract void	mv(Transpose trans, double alpha, double[] x, double beta, double[] y) Matrix-vector multiplication.
abstract DMatrix	set(int i, int j, double x) Sets A[i, j] = x.
double	trace() Returns the matrix trace.
double[]	tv(double[] x) Returns Matrix-vector multiplication A' * x.
void	tv(double[] x, double[] y) Matrix-vector multiplication y = A' * x.
void	tv(double alpha, double[] x, double beta, double[] y) Matrix-vector multiplication.
DMatrix	update(int i, int j, double x) Sets A[i, j] = x for Scala users.

Methods inherited from class smile.math.matrix.IMatrix

colName, colNames, colNames, mv, ncols, nrows, rowName, rowNames, rowNames, size, toString, toString, toString, tv

Methods inherited from class java.lang.Object

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

Constructor Detail

DMatrix

public DMatrix()

Method Detail

set

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

Sets A[i, j] = x.

update

public DMatrix update(int i,
                      int j,
                      double x)

Sets A[i, j] = x for Scala users.

get

public abstract double get(int i,
                           int j)

Returns A[i, j].

apply

public double apply(int i,
                    int j)

Returns A[i, j] for Scala users.

diag

public double[] diag()

Returns the diagonal elements.

trace

public double trace()

Returns the matrix trace. The sum of the diagonal elements.

mv

public abstract void mv(Transpose trans,
                        double alpha,
                        double[] x,
                        double beta,
                        double[] y)

Matrix-vector multiplication.

     y = alpha * op(A) * x + beta * y
 

where op is the transpose operation.

mv

public double[] mv(double[] x)

Description copied from class: IMatrix

Returns the matrix-vector multiplication A * x.

Specified by:

mv in class IMatrix<double[]>

mv

public void mv(double[] x,
               double[] y)

Description copied from class: IMatrix

Matrix-vector multiplication y = A * x.

Specified by:

mv in class IMatrix<double[]>

mv

public void mv(double alpha,
               double[] x,
               double beta,
               double[] y)

Matrix-vector multiplication.

     y = alpha * A * x + beta * y
 

tv

public double[] tv(double[] x)

Description copied from class: IMatrix

Returns Matrix-vector multiplication A' * x.

Specified by:

tv in class IMatrix<double[]>

tv

public void tv(double[] x,
               double[] y)

Description copied from class: IMatrix

Matrix-vector multiplication y = A' * x.

Specified by:

tv in class IMatrix<double[]>

tv

public void tv(double alpha,
               double[] x,
               double beta,
               double[] y)

Matrix-vector multiplication.

     y = alpha * A' * x + beta * y
 

market

public static DMatrix market(java.nio.file.Path path)
                      throws java.io.IOException,
                             java.text.ParseException

Reads a matrix from a Matrix Market File Format file. For details, see http://people.sc.fsu.edu/~jburkardt/data/mm/mm.html. The returned matrix may be dense or sparse.

Parameters:

path - the input file path.

Returns:

a dense or sparse matrix.

Throws:

java.io.IOException

java.text.ParseException