org.wallerlab.yoink.math.linear

Class CommonsMatrix

java.lang.Object

org.wallerlab.yoink.math.linear.CommonsMatrix

All Implemented Interfaces:

Matrix<org.apache.commons.math3.linear.RealMatrix>

public class CommonsMatrix
extends java.lang.Object
implements Matrix<org.apache.commons.math3.linear.RealMatrix>

Matrix Adaptor pattern. this class i sto convert from our own implementation to the appache commons maths lib.

Nested Class Summary

Nested classes/interfaces inherited from interface org.wallerlab.yoink.api.service.math.Matrix

Matrix.Type

Constructor Summary

Constructors

Constructor and Description
CommonsMatrix()
CommonsMatrix(int rowDimension, int columnDimension)

Method Summary

Modifier and Type	Method and Description
Matrix	add(Matrix m) add one matrix to this matrix
void	addToEntry(int row, int column, double value) add a value to one element in this matrix
void	array2DRowRealMatrix(double[][] d) initialize this matrix with two-dimensional double array
double	distance(Matrix m) get the distance between this matrix and another matrix m.it works when matrix is a vector
double	dotProduct() get the dot product of this matrix.
double	dotProduct(Matrix m) get the dot product of this matrix and another matrix m.
Matrix	ebeMultiply(Matrix m) Element-by-element multiplication of two 3D vectors.
boolean	equals(Matrix m) check if this matrix equals another matrix m.
double[][]	getData() get the value of this matrix in the form a two-dimensional double array
double	getEntry(int row, int column) get the value of one element in this matrix
org.apache.commons.math3.linear.RealMatrix	getInternalMatrix() get the value of internal matrix of this matrix
double	getNorm() get the norm of this matrix.
double[]	getRow(int i) get the value of one row in this matrix in the form of one-dimensional double array.
Matrix	scalarMultiply(double d) scalar this matrix with a double value
void	setEntry(int row, int column, double value) set the value of one element in this matrix
void	setInternalMatrix(org.apache.commons.math3.linear.RealMatrix internalMatrix) set the value of internal matrix of this matrix
Matrix	subtract(Matrix m) subtract one matrix from this matrix
Matrix	transpose() transpose this matrix

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonsMatrix

public CommonsMatrix()

CommonsMatrix

public CommonsMatrix(int rowDimension,
                     int columnDimension)

Method Detail

array2DRowRealMatrix

public void array2DRowRealMatrix(double[][] d)

Description copied from interface: Matrix

initialize this matrix with two-dimensional double array

Specified by:

array2DRowRealMatrix in interface Matrix<org.apache.commons.math3.linear.RealMatrix>

Parameters:

d - , a two dimensional double array

setEntry

public void setEntry(int row,
                     int column,
                     double value)

Description copied from interface: Matrix

set the value of one element in this matrix

Specified by:

setEntry in interface Matrix<org.apache.commons.math3.linear.RealMatrix>

Parameters:

row - -integer, the row index

column - -integer, the column index

value - - the value of the element, Double

addToEntry

public void addToEntry(int row,
                       int column,
                       double value)

Description copied from interface: Matrix

add a value to one element in this matrix

Specified by:

addToEntry in interface Matrix<org.apache.commons.math3.linear.RealMatrix>

Parameters:

row - -integer, the row index

column - -integer, the column index

value - - Double,the value added to the element

getEntry

public double getEntry(int row,
                       int column)

Description copied from interface: Matrix

get the value of one element in this matrix

Specified by:

getEntry in interface Matrix<org.apache.commons.math3.linear.RealMatrix>

Parameters:

row - -integer, the row index

column - -integer, the column index

Returns:

the element value -Double

transpose

public Matrix transpose()

Description copied from interface: Matrix

transpose this matrix

Specified by:

transpose in interface Matrix<org.apache.commons.math3.linear.RealMatrix>

Returns:

a matrix -Matrix

add

public Matrix add(Matrix m)

Description copied from interface: Matrix

add one matrix to this matrix

Specified by:

add in interface Matrix<org.apache.commons.math3.linear.RealMatrix>

Parameters:

m - -Matrix will be added to this matrix

Returns:

a matrix -Matrix

subtract

public Matrix subtract(Matrix m)

Description copied from interface: Matrix

subtract one matrix from this matrix

Specified by:

subtract in interface Matrix<org.apache.commons.math3.linear.RealMatrix>

Parameters:

m - -Matrix will be subtracted from this matrix

Returns:

a matrix -Matrix

scalarMultiply

public Matrix scalarMultiply(double d)

Description copied from interface: Matrix

scalar this matrix with a double value

Specified by:

scalarMultiply in interface Matrix<org.apache.commons.math3.linear.RealMatrix>

Parameters:

d - , scalar value, -Double

Returns:

a matrix -Matrix

dotProduct

public double dotProduct()

Description copied from interface: Matrix

get the dot product of this matrix. it works when matrix is a vector

Specified by:

dotProduct in interface Matrix<org.apache.commons.math3.linear.RealMatrix>

Returns:

Double

getData

public double[][] getData()

Description copied from interface: Matrix

get the value of this matrix in the form a two-dimensional double array

Specified by:

getData in interface Matrix<org.apache.commons.math3.linear.RealMatrix>

Returns:

a two-dimensional double array

getRow

public double[] getRow(int i)

Description copied from interface: Matrix

get the value of one row in this matrix in the form of one-dimensional double array.

Specified by:

getRow in interface Matrix<org.apache.commons.math3.linear.RealMatrix>

Parameters:

i - , the row index

Returns:

one-dimensional double array

getInternalMatrix

public org.apache.commons.math3.linear.RealMatrix getInternalMatrix()

Description copied from interface: Matrix

get the value of internal matrix of this matrix

Specified by:

getInternalMatrix in interface Matrix<org.apache.commons.math3.linear.RealMatrix>

Returns:

a matrix in the matrix type of the library

setInternalMatrix

public void setInternalMatrix(org.apache.commons.math3.linear.RealMatrix internalMatrix)

Description copied from interface: Matrix

set the value of internal matrix of this matrix

Specified by:

setInternalMatrix in interface Matrix<org.apache.commons.math3.linear.RealMatrix>

Parameters:

internalMatrix - , a matrix of the library

ebeMultiply

public Matrix ebeMultiply(Matrix m)

Element-by-element multiplication of two 3D vectors.

Specified by:

ebeMultiply in interface Matrix<org.apache.commons.math3.linear.RealMatrix>

Parameters:

m - ,a matrix -Matrix

Returns:

a matrix -Matrix

distance

public double distance(Matrix m)

Description copied from interface: Matrix

get the distance between this matrix and another matrix m.it works when matrix is a vector

Specified by:

distance in interface Matrix<org.apache.commons.math3.linear.RealMatrix>

Parameters:

m - -Matrix

Returns:

Double

getNorm

public double getNorm()

Description copied from interface: Matrix

get the norm of this matrix. it works when matrix is a vector

Specified by:

getNorm in interface Matrix<org.apache.commons.math3.linear.RealMatrix>

Returns:

Double

equals

public boolean equals(Matrix m)

Description copied from interface: Matrix

check if this matrix equals another matrix m.

Specified by:

equals in interface Matrix<org.apache.commons.math3.linear.RealMatrix>

Parameters:

m - -Matrix

Returns:

Boolean

dotProduct

public double dotProduct(Matrix m)

Description copied from interface: Matrix

get the dot product of this matrix and another matrix m. it works when matrix is a vector

Specified by:

dotProduct in interface Matrix<org.apache.commons.math3.linear.RealMatrix>

Parameters:

m - to be used for operation

Returns:

Double