smile.math.matrix

Class SMatrix

java.lang.Object

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

smile.math.matrix.SMatrix

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

FloatBandMatrix, FloatMatrix, FloatSparseMatrix, FloatSymmMatrix

public abstract class SMatrix
extends IMatrix<float[]>

Single precision matrix base class.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SMatrix()

Method Summary

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

SMatrix

public SMatrix()

Method Detail

set

public abstract SMatrix set(int i,
                            int j,
                            float x)

Sets A[i,j] = x.

update

public SMatrix update(int i,
                      int j,
                      float x)

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

get

public abstract float get(int i,
                          int j)

Returns A[i, j].

apply

public float apply(int i,
                   int j)

Returns A[i, j]. For Scala users.

diag

public float[] diag()

Returns the diagonal elements.

trace

public float trace()

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

mv

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

Matrix-vector multiplication.

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

where op is the transpose operation.

mv

public float[] mv(float[] x)

Description copied from class: IMatrix

Returns the matrix-vector multiplication A * x.

Specified by:

mv in class IMatrix<float[]>

mv

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

Description copied from class: IMatrix

Matrix-vector multiplication y = A * x.

Specified by:

mv in class IMatrix<float[]>

mv

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

Matrix-vector multiplication.

     y = alpha * A * x + beta * y
 

tv

public float[] tv(float[] x)

Description copied from class: IMatrix

Returns Matrix-vector multiplication A' * x.

Specified by:

tv in class IMatrix<float[]>

tv

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

Description copied from class: IMatrix

Matrix-vector multiplication y = A' * x.

Specified by:

tv in class IMatrix<float[]>

tv

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

Matrix-vector multiplication.

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

market

public static SMatrix 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