JSci.maths.matrices
Class AbstractDoubleSquareMatrix

java.lang.Object
  JSci.maths.matrices.Matrix
      JSci.maths.matrices.AbstractDoubleMatrix
          JSci.maths.matrices.AbstractDoubleSquareMatrix

All Implemented Interfaces:

java.io.Serializable, Algebra.Member, Module.Member, VectorSpace.Member, Ring.Member, AbelianGroup.Member, SquareMatrix, Member

Direct Known Subclasses:

DoubleDiagonalMatrix, DoubleFileSquareMatrix, DoubleSparseSquareMatrix, DoubleSquareMatrix, DoubleTridiagonalMatrix

public abstract class AbstractDoubleSquareMatrix
extends AbstractDoubleMatrix
implements SquareMatrix

The AbstractDoubleSquareMatrix class provides an object for encapsulating double square matrices.

See Also:

Serialized Form

Field Summary

protected DoubleLUCache

luCache

Fields inherited from class JSci.maths.matrices.Matrix

numCols, numRows

Constructor Summary

protected

AbstractDoubleSquareMatrix(int size) Constructs a matrix.

Method Summary

AbstractDoubleMatrix	add(AbstractDoubleMatrix m) Returns the addition of this matrix and another.
AbstractDoubleSquareMatrix	add(AbstractDoubleSquareMatrix m) Returns the addition of this matrix and another.
AbstractDoubleSquareMatrix[]	choleskyDecompose() Returns the Cholesky decomposition of this matrix.
double	det() Returns the determinant.
AbstractDoubleSquareMatrix	directSum(AbstractDoubleSquareMatrix m) Returns the direct sum of this matrix and another.
AbstractDoubleSquareMatrix	inverse() Returns the inverse of this matrix.
boolean	isSymmetric() Returns true if this matrix is symmetric.
boolean	isUnitary() Returns true if this matrix is unitary.
protected AbstractDoubleSquareMatrix[]	luDecompose_cache(int[] pivot)
AbstractDoubleSquareMatrix[]	luDecompose() Returns the LU decomposition of this matrix.
AbstractDoubleSquareMatrix[]	luDecompose(int[] pivot) Returns the LU decomposition of this matrix.
AbstractDoubleMatrix	mapElements(Mapping f) Applies a function on all the matrix elements.
AbstractDoubleSquareMatrix	multiply(AbstractDoubleSquareMatrix m) Returns the multiplication of this matrix and another.
AbelianGroup.Member	negate() Returns the negative of this matrix.
double	operatorNorm() Returns the operator norm.
AbstractDoubleSquareMatrix[]	polarDecompose() Returns the polar decomposition of this matrix.
AbstractDoubleSquareMatrix[]	qrDecompose() Returns the QR decomposition of this matrix.
AbstractDoubleMatrix	scalarDivide(double x) Returns the division of this matrix by a scalar.
AbstractDoubleMatrix	scalarMultiply(double x) Returns the multiplication of this matrix by a scalar.
double	scalarProduct(AbstractDoubleMatrix m) Returns the scalar product of this matrix and another.
double	scalarProduct(AbstractDoubleSquareMatrix m) Returns the scalar product of this matrix and another.
AbstractDoubleSquareMatrix[]	singularValueDecompose() Returns the singular value decomposition of this matrix.
AbstractDoubleMatrix	subtract(AbstractDoubleMatrix m) Returns the subtraction of this matrix and another.
AbstractDoubleSquareMatrix	subtract(AbstractDoubleSquareMatrix m) Returns the subtraction of this matrix by another.
AbstractDoubleSquareMatrix	tensor(AbstractDoubleSquareMatrix m) Returns the tensor product of this matrix and another.
AbstractComplexMatrix	toComplexMatrix() Converts this matrix to a complex matrix.
AbstractIntegerMatrix	toIntegerMatrix() Converts this matrix to an integer matrix.
double	trace() Returns the trace.
Matrix	transpose() Returns the transpose of this matrix.

Methods inherited from class JSci.maths.matrices.AbstractDoubleMatrix

add, directSum, equals, equals, equals, frobeniusNorm, getElement, getSet, hashCode, infNorm, multiply, multiply, multiply, scalarDivide, scalarMultiply, setElement, subtract, tensor, toString

Methods inherited from class JSci.maths.matrices.Matrix

columns, getInvalidElementMsg, rows

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

luCache

protected transient DoubleLUCache luCache

Constructor Detail

AbstractDoubleSquareMatrix

protected AbstractDoubleSquareMatrix(int size)

Constructs a matrix.

Method Detail

toIntegerMatrix

public AbstractIntegerMatrix toIntegerMatrix()

Converts this matrix to an integer matrix.

Overrides:

toIntegerMatrix in class AbstractDoubleMatrix

Returns:

an integer square matrix

toComplexMatrix

public AbstractComplexMatrix toComplexMatrix()

Converts this matrix to a complex matrix.

Overrides:

toComplexMatrix in class AbstractDoubleMatrix

Returns:

a complex square matrix

isSymmetric

public boolean isSymmetric()

Returns true if this matrix is symmetric.

isUnitary

public boolean isUnitary()

Returns true if this matrix is unitary.

det

public double det()

Returns the determinant.

trace

public double trace()

Returns the trace.

operatorNorm

public double operatorNorm()
                    throws MaximumIterationsExceededException

Returns the operator norm.

Throws:

MaximumIterationsExceededException - If it takes more than 50 iterations to determine an eigenvalue.

negate

public AbelianGroup.Member negate()

Returns the negative of this matrix.

Specified by:

negate in interface AbelianGroup.Member

Overrides:

negate in class AbstractDoubleMatrix

add

public final AbstractDoubleMatrix add(AbstractDoubleMatrix m)

Returns the addition of this matrix and another.

Overrides:

add in class AbstractDoubleMatrix

Parameters:

m - a double square matrix

Throws:

MatrixDimensionException - If the matrices are not square or different sizes.

add

public AbstractDoubleSquareMatrix add(AbstractDoubleSquareMatrix m)

Returns the addition of this matrix and another.

Parameters:

m - a double square matrix

Throws:

MatrixDimensionException - If the matrices are different sizes.

subtract

public final AbstractDoubleMatrix subtract(AbstractDoubleMatrix m)

Returns the subtraction of this matrix and another.

Overrides:

subtract in class AbstractDoubleMatrix

Parameters:

m - a double square matrix

Throws:

MatrixDimensionException - If the matrices are not square or different sizes.

subtract

public AbstractDoubleSquareMatrix subtract(AbstractDoubleSquareMatrix m)

Returns the subtraction of this matrix by another.

Parameters:

m - a double square matrix

Throws:

MatrixDimensionException - If the matrices are different sizes.

scalarMultiply

public AbstractDoubleMatrix scalarMultiply(double x)

Returns the multiplication of this matrix by a scalar.

Overrides:

scalarMultiply in class AbstractDoubleMatrix

Parameters:

x - a double.

Returns:

a double square matrix.

scalarDivide

public AbstractDoubleMatrix scalarDivide(double x)

Returns the division of this matrix by a scalar.

Overrides:

scalarDivide in class AbstractDoubleMatrix

Parameters:

x - a double.

Returns:

a double square matrix.

scalarProduct

public final double scalarProduct(AbstractDoubleMatrix m)

Returns the scalar product of this matrix and another.

Overrides:

scalarProduct in class AbstractDoubleMatrix

Parameters:

m - a double square matrix.

Throws:

MatrixDimensionException - If the matrices are not square or different sizes.

scalarProduct

public double scalarProduct(AbstractDoubleSquareMatrix m)

Returns the scalar product of this matrix and another.

Parameters:

m - a double square matrix.

Throws:

MatrixDimensionException - If the matrices are different sizes.

multiply

public AbstractDoubleSquareMatrix multiply(AbstractDoubleSquareMatrix m)

Returns the multiplication of this matrix and another.

Parameters:

m - a double square matrix

Throws:

MatrixDimensionException - If the matrices are different sizes.

directSum

public AbstractDoubleSquareMatrix directSum(AbstractDoubleSquareMatrix m)

Returns the direct sum of this matrix and another.

tensor

public AbstractDoubleSquareMatrix tensor(AbstractDoubleSquareMatrix m)

Returns the tensor product of this matrix and another.

transpose

public Matrix transpose()

Returns the transpose of this matrix.

Overrides:

transpose in class AbstractDoubleMatrix

Returns:

a double square matrix

inverse

public AbstractDoubleSquareMatrix inverse()

Returns the inverse of this matrix.

Returns:

a double square matrix.

luDecompose

public AbstractDoubleSquareMatrix[] luDecompose(int[] pivot)

Returns the LU decomposition of this matrix.

Parameters:

pivot - an empty array of length rows()+1 to hold the pivot information (null if not interested). The last array element will contain the parity.

Returns:

an array with [0] containing the L-matrix and [1] containing the U-matrix.

PlanetMath references:

LUDecomposition

luDecompose_cache

protected AbstractDoubleSquareMatrix[] luDecompose_cache(int[] pivot)

luDecompose

public AbstractDoubleSquareMatrix[] luDecompose()

Returns the LU decomposition of this matrix. Warning: no pivoting.

Returns:

an array with [0] containing the L-matrix and [1] containing the U-matrix.

PlanetMath references:

LUDecomposition

choleskyDecompose

public AbstractDoubleSquareMatrix[] choleskyDecompose()

Returns the Cholesky decomposition of this matrix. Matrix must be symmetric and positive definite.

Returns:

an array with [0] containing the L-matrix and [1] containing the U-matrix.

PlanetMath references:

CholeskyDecomposition

qrDecompose

public AbstractDoubleSquareMatrix[] qrDecompose()

Returns the QR decomposition of this matrix. Based on the code from JAMA (public domain).

Returns:

an array with [0] containing the Q-matrix and [1] containing the R-matrix.

PlanetMath references:

QRDecomposition

singularValueDecompose

public AbstractDoubleSquareMatrix[] singularValueDecompose()

Returns the singular value decomposition of this matrix. Based on the code from JAMA (public domain).

Returns:

an array with [0] containing the U-matrix, [1] containing the S-matrix and [2] containing the V-matrix.

PlanetMath references:

SingularValueDecomposition

polarDecompose

public AbstractDoubleSquareMatrix[] polarDecompose()

Returns the polar decomposition of this matrix.

mapElements

public AbstractDoubleMatrix mapElements(Mapping f)

Applies a function on all the matrix elements.

Overrides:

mapElements in class AbstractDoubleMatrix

Parameters:

f - a user-defined function

Returns:

a double square matrix