jsat.linear

Class GenericMatrix

java.lang.Object

jsat.linear.Matrix

jsat.linear.GenericMatrix

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

DenseMatrix, MatrixOfVecs, RandomMatrix, SubMatrix, TransposeView

public abstract class GenericMatrix
extends Matrix

This Class provides default implementations of most all functions in row major form. Only a small portion must be implemented by the extending class

Author:

Edward Raff

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	NB2 Step size if the computation accesses 2*NB2^2 * dataTypeSize data, so that the data being worked on fits into the L2 cache

Constructor Summary

Constructors

Constructor and Description
GenericMatrix()

Method Summary

Modifier and Type	Method and Description
Matrix	clone()
protected abstract Matrix	getMatrixOfSameType(int rows, int cols) Creates a new matrix of the same type
Matrix[]	lup()
Matrix[]	lup(ExecutorService threadPool)
void	multiply(Matrix b, Matrix C) Alters the matrix C to be equal to C = C+A*B
void	multiply(Matrix b, Matrix C, ExecutorService threadPool) Alters the matrix C to be equal to C = C+A*B
void	multiply(Vec b, double z, Vec c) If this matrix is Am x n, and b has a length of n, and c has a length of m, then this will mutate c to store c = c + A*b*z
void	multiplyTranspose(Matrix b, Matrix C) Alters the matrix C to be equal to C = C+A*BT
void	multiplyTranspose(Matrix b, Matrix C, ExecutorService threadPool) Alters the matrix C to be equal to C = C+A*BT
void	mutableAdd(double c) Alters the current matrix to store the value A+c
void	mutableAdd(double c, ExecutorService threadPool) Alters the current matrix to store the value A+c
void	mutableAdd(double c, Matrix b) Alters the current matrix to store the value A+c*B
void	mutableAdd(double c, Matrix b, ExecutorService threadPool) Alters the current matrix to store the value A+c*B
void	mutableMultiply(double c) Alters the current matrix to be equal to A*c
void	mutableMultiply(double c, ExecutorService threadPool) Alters the current matrix to be equal to A*c
void	mutableTranspose() Transposes the current matrix in place, altering its value.
Matrix[]	qr()
Matrix[]	qr(ExecutorService threadPool)
void	swapRows(int r1, int r2) Alters the current matrix by swapping the values stored in two different rows.
void	transpose(Matrix C) Overwrites the values stored in matrix C to store the value of A'
void	transposeMultiply(double c, Vec b, Vec x) Alters the vector x to be equal to x = x + A'*b*c
void	transposeMultiply(Matrix b, Matrix C) Alters the matrix C so that C = C + A'*B
void	transposeMultiply(Matrix b, Matrix C, ExecutorService threadPool) Alters the matrix C so that C = C + A'*B
void	zeroOut() Alters the current matrix so that all values are equal to zero.

Methods inherited from class jsat.linear.Matrix

add, add, add, add, canBeMutated, canMultiply, changeSize, cols, copyTo, diag, diagMult, diagMult, equals, equals, eye, get, getColumn, getColumnView, getRow, getRowView, increment, isSparce, isSquare, isSymmetric, isSymmetric, multiply, multiply, multiply, multiply, multiply, multiplyTranspose, multiplyTranspose, mutableAdd, mutableAdd, mutableSubtract, mutableSubtract, mutableSubtract, mutableSubtract, mutableSubtract, mutableSubtract, nnz, OuterProductUpdate, OuterProductUpdate, pascal, random, rows, sameDimensions, set, subtract, subtract, subtract, subtract, toString, transpose, transposeMultiply, transposeMultiply, transposeMultiply, updateRow

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NB2

protected static int NB2

Step size if the computation accesses 2*NB2^2 * dataTypeSize data, so that the data being worked on fits into the L2 cache

Constructor Detail

GenericMatrix

public GenericMatrix()

Method Detail

getMatrixOfSameType

protected abstract Matrix getMatrixOfSameType(int rows,
                                              int cols)

Creates a new matrix of the same type

Parameters:

rows - the number of rows for the matrix to have

cols - the number of columns for the matrix to have

Returns:

the empty all zero new matrix

mutableAdd

public void mutableAdd(double c,
                       Matrix b)

Description copied from class: Matrix

Alters the current matrix to store the value A+c*B

Specified by:

mutableAdd in class Matrix

Parameters:

c - the scalar constant to multiple B by

b - the matrix to add to this

mutableAdd

public void mutableAdd(double c,
                       Matrix b,
                       ExecutorService threadPool)

Description copied from class: Matrix

Alters the current matrix to store the value A+c*B

Specified by:

mutableAdd in class Matrix

Parameters:

c - the scalar constant to multiple B by

b - the matrix to add to this

threadPool - the source of threads to do computation in parallel

mutableAdd

public void mutableAdd(double c)

Description copied from class: Matrix

Alters the current matrix to store the value A+c

Specified by:

mutableAdd in class Matrix

Parameters:

c - the scalar constant to add to this

mutableAdd

public void mutableAdd(double c,
                       ExecutorService threadPool)

Description copied from class: Matrix

Alters the current matrix to store the value A+c

Specified by:

mutableAdd in class Matrix

Parameters:

c - the scalar constant to add to this

threadPool - the source of threads to do computation in parallel

multiply

public void multiply(Vec b,
                     double z,
                     Vec c)

Description copied from class: Matrix

If this matrix is A_{m x n}, and b has a length of n, and c has a length of m, then this will mutate c to store c = c + A*b*z

Specified by:

multiply in class Matrix

Parameters:

b - the vector to be treated as a colum vector

z - the constant to multiply the A*b value by.

c - where to place the result by addition

multiply

public void multiply(Matrix b,
                     Matrix C)

Description copied from class: Matrix

Alters the matrix C to be equal to C = C+A*B

Specified by:

multiply in class Matrix

Parameters:

b - the matrix to multiply this with

C - the matrix to add the result to

multiplyTranspose

public void multiplyTranspose(Matrix b,
                              Matrix C)

Description copied from class: Matrix

Alters the matrix C to be equal to C = C+A*B^T

Specified by:

multiplyTranspose in class Matrix

Parameters:

b - the matrix to multiply this with

C - the matrix to add the result to

multiplyTranspose

public void multiplyTranspose(Matrix b,
                              Matrix C,
                              ExecutorService threadPool)

Description copied from class: Matrix

Alters the matrix C to be equal to C = C+A*B^T

Specified by:

multiplyTranspose in class Matrix

Parameters:

b - the matrix to multiply this with

C - the matrix to add the result to

threadPool - the source of threads to do computation in parallel

multiply

public void multiply(Matrix b,
                     Matrix C,
                     ExecutorService threadPool)

Description copied from class: Matrix

Alters the matrix C to be equal to C = C+A*B

Specified by:

multiply in class Matrix

Parameters:

b - the matrix to multiply this with

C - the matrix to add the result to

threadPool - the source of threads to do computation in parallel

mutableMultiply

public void mutableMultiply(double c)

Description copied from class: Matrix

Alters the current matrix to be equal to A*c

Specified by:

mutableMultiply in class Matrix

Parameters:

c - the scalar constant to multiply by

mutableMultiply

public void mutableMultiply(double c,
                            ExecutorService threadPool)

Description copied from class: Matrix

Alters the current matrix to be equal to A*c

Specified by:

mutableMultiply in class Matrix

Parameters:

c - the scalar constant to multiply by

threadPool - the source of threads to do computation in parallel

transposeMultiply

public void transposeMultiply(double c,
                              Vec b,
                              Vec x)

Description copied from class: Matrix

Alters the vector x to be equal to x = x + A'*b*c

Specified by:

transposeMultiply in class Matrix

Parameters:

c - the scalar constant to multiply by

b - the vector to multiply by

x - the vector the add the result to

transposeMultiply

public void transposeMultiply(Matrix b,
                              Matrix C)

Description copied from class: Matrix

Alters the matrix C so that C = C + A'*B

Specified by:

transposeMultiply in class Matrix

Parameters:

b - the matrix to multiply by

C - the matrix to add the result to

transposeMultiply

public void transposeMultiply(Matrix b,
                              Matrix C,
                              ExecutorService threadPool)

Description copied from class: Matrix

Alters the matrix C so that C = C + A'*B

Specified by:

transposeMultiply in class Matrix

Parameters:

b - the matrix to multiply by

C - the matrix to place the results in

threadPool - the source of threads to do computation in parallel

mutableTranspose

public void mutableTranspose()

Description copied from class: Matrix

Transposes the current matrix in place, altering its value. Only valid for square matrices

Specified by:

mutableTranspose in class Matrix

transpose

public void transpose(Matrix C)

Description copied from class: Matrix

Overwrites the values stored in matrix C to store the value of A'

Specified by:

transpose in class Matrix

Parameters:

C - the matrix to store the transpose of the current matrix

swapRows

public void swapRows(int r1,
                     int r2)

Description copied from class: Matrix

Alters the current matrix by swapping the values stored in two different rows.

Specified by:

swapRows in class Matrix

Parameters:

r1 - the first row to swap

r2 - the second row to swap

zeroOut

public void zeroOut()

Description copied from class: Matrix

Alters the current matrix so that all values are equal to zero.

Specified by:

zeroOut in class Matrix

lup

public Matrix[] lup()

Specified by:

lup in class Matrix

lup

public Matrix[] lup(ExecutorService threadPool)

Specified by:

lup in class Matrix

qr

public Matrix[] qr()

Specified by:

qr in class Matrix

qr

public Matrix[] qr(ExecutorService threadPool)

Specified by:

qr in class Matrix

clone

public Matrix clone()

Specified by:

clone in class Matrix