JSci.maths.matrices
Class DoubleSparseSquareMatrix

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

All Implemented Interfaces:

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

public final class DoubleSparseSquareMatrix
extends AbstractDoubleSquareMatrix

The DoubleSparseSquareMatrix class provides an object for encapsulating sparse square matrices. Uses compressed row storage (Yale sparse matrix format).

See Also:

Serialized Form

Field Summary

Fields inherited from class JSci.maths.matrices.AbstractDoubleSquareMatrix

luCache

Fields inherited from class JSci.maths.matrices.Matrix

numCols, numRows

Constructor Summary

DoubleSparseSquareMatrix(double[][] array)
Constructs a matrix from an array.

DoubleSparseSquareMatrix(int size)
Constructs an empty matrix.

DoubleSparseSquareMatrix(int size, int capacityIncrement)

Method Summary

AbstractDoubleSquareMatrix	add(AbstractDoubleSquareMatrix m) Returns the addition of this matrix and another.
DoubleSparseSquareMatrix	add(DoubleSparseSquareMatrix m) Returns the addition of this matrix and another.
DoubleSquareMatrix	add(DoubleSquareMatrix m)
AbstractDoubleSquareMatrix[]	choleskyDecompose() Returns the Cholesky decomposition of this matrix.
double	det() Returns the determinant.
int	elementCount() Returns the number of non-zero elements.
boolean	equals(AbstractDoubleSquareMatrix m, double tol) Compares two double sparse square matrices for equality.
boolean	equals(DoubleSparseSquareMatrix m)
boolean	equals(DoubleSparseSquareMatrix m, double tol)
double	frobeniusNorm() Returns the Frobenius (l2) norm.
double	getElement(int i, int j) Returns an element of the matrix.
double	infNorm() Returns the l-norm.
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.
AbstractDoubleVector	multiply(AbstractDoubleVector v) Returns the multiplication of a vector by this matrix.
DoubleSparseSquareMatrix	multiply(DoubleSparseSquareMatrix m) Returns the multiplication of this matrix and another.
AbstractDoubleVector	multiply(DoubleSparseVector v) Returns the multiplication of a sparse vector by this matrix.
DoubleSquareMatrix	multiply(DoubleSquareMatrix m)
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(AbstractDoubleSquareMatrix m) Returns the scalar product of this matrix and another.
double	scalarProduct(DoubleSquareMatrix m)
void	setElement(int i, int j, double x) Sets the value of an element of the matrix.
AbstractDoubleSquareMatrix	subtract(AbstractDoubleSquareMatrix m) Returns the subtraction of this matrix and another.
DoubleSparseSquareMatrix	subtract(DoubleSparseSquareMatrix m) Returns the addition of this matrix and another.
DoubleSquareMatrix	subtract(DoubleSquareMatrix m)
AbstractComplexMatrix	toComplexMatrix() Converts this matrix to a complex matrix.
AbstractIntegerMatrix	toIntegerMatrix() Converts this matrix to an integer matrix.
java.lang.String	toString() Returns a string representing this matrix.
double	trace() Returns the trace.
Matrix	transpose() Returns the transpose of this matrix.

Methods inherited from class JSci.maths.matrices.AbstractDoubleSquareMatrix

add, directSum, inverse, isSymmetric, isUnitary, luDecompose_cache, negate, operatorNorm, polarDecompose, qrDecompose, scalarProduct, singularValueDecompose, subtract, tensor

Methods inherited from class JSci.maths.matrices.AbstractDoubleMatrix

add, directSum, equals, equals, equals, getSet, hashCode, multiply, multiply, scalarDivide, scalarMultiply, subtract, tensor

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

Constructor Detail

DoubleSparseSquareMatrix

public DoubleSparseSquareMatrix(int size)

Constructs an empty matrix.

Parameters:

size - the number of rows/columns

DoubleSparseSquareMatrix

public DoubleSparseSquareMatrix(int size,
                                int capacityIncrement)

DoubleSparseSquareMatrix

public DoubleSparseSquareMatrix(double[][] array)

Constructs a matrix from an array.

Parameters:

array - an assigned value

Throws:

MatrixDimensionException - If the array is not square.

Method Detail

equals

public boolean equals(AbstractDoubleSquareMatrix m,
                      double tol)

Compares two double sparse square matrices for equality.

Parameters:

m - a double matrix

equals

public final boolean equals(DoubleSparseSquareMatrix m)

equals

public boolean equals(DoubleSparseSquareMatrix m,
                      double tol)

toString

public java.lang.String toString()

Returns a string representing this matrix.

Overrides:

toString in class AbstractDoubleMatrix

toIntegerMatrix

public AbstractIntegerMatrix toIntegerMatrix()

Converts this matrix to an integer matrix.

Overrides:

toIntegerMatrix in class AbstractDoubleSquareMatrix

Returns:

an integer square matrix

toComplexMatrix

public AbstractComplexMatrix toComplexMatrix()

Converts this matrix to a complex matrix.

Overrides:

toComplexMatrix in class AbstractDoubleSquareMatrix

Returns:

a complex square matrix

getElement

public double getElement(int i,
                         int j)

Returns an element of the matrix.

Specified by:

getElement in class AbstractDoubleMatrix

Parameters:

i - row index of the element

j - column index of the element

Throws:

MatrixDimensionException - If attempting to access an invalid element.

setElement

public void setElement(int i,
                       int j,
                       double x)

Sets the value of an element of the matrix.

Specified by:

setElement in class AbstractDoubleMatrix

Parameters:

i - row index of the element

j - column index of the element

x - a number

Throws:

MatrixDimensionException - If attempting to access an invalid element.

elementCount

public int elementCount()

Returns the number of non-zero elements.

det

public double det()

Returns the determinant.

Overrides:

det in class AbstractDoubleSquareMatrix

trace

public double trace()

Returns the trace.

Overrides:

trace in class AbstractDoubleSquareMatrix

infNorm

public double infNorm()

Returns the l-norm.

Overrides:

infNorm in class AbstractDoubleMatrix

frobeniusNorm

public double frobeniusNorm()

Returns the Frobenius (l²) norm.

Overrides:

frobeniusNorm in class AbstractDoubleMatrix

add

public AbstractDoubleSquareMatrix add(AbstractDoubleSquareMatrix m)

Returns the addition of this matrix and another.

Overrides:

add in class AbstractDoubleSquareMatrix

Parameters:

m - a double matrix

Throws:

MatrixDimensionException - If the matrices are different sizes.

add

public DoubleSquareMatrix add(DoubleSquareMatrix m)

add

public DoubleSparseSquareMatrix add(DoubleSparseSquareMatrix m)

Returns the addition of this matrix and another.

Parameters:

m - a double sparse matrix

Throws:

MatrixDimensionException - If the matrices are different sizes.

subtract

public AbstractDoubleSquareMatrix subtract(AbstractDoubleSquareMatrix m)

Returns the subtraction of this matrix and another.

Overrides:

subtract in class AbstractDoubleSquareMatrix

Parameters:

m - a double matrix

Throws:

MatrixDimensionException - If the matrices are different sizes.

subtract

public DoubleSquareMatrix subtract(DoubleSquareMatrix m)

subtract

public DoubleSparseSquareMatrix subtract(DoubleSparseSquareMatrix m)

Returns the addition of this matrix and another.

Parameters:

m - a double sparse 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 AbstractDoubleSquareMatrix

Parameters:

x - a double

Returns:

a double sparse matrix

scalarDivide

public AbstractDoubleMatrix scalarDivide(double x)

Description copied from class: AbstractDoubleSquareMatrix

Returns the division of this matrix by a scalar.

Overrides:

scalarDivide in class AbstractDoubleSquareMatrix

Parameters:

x - a double.

Returns:

a double square matrix.

scalarProduct

public double scalarProduct(AbstractDoubleSquareMatrix m)

Returns the scalar product of this matrix and another.

Overrides:

scalarProduct in class AbstractDoubleSquareMatrix

Parameters:

m - a double matrix.

Throws:

MatrixDimensionException - If the matrices are different sizes.

scalarProduct

public double scalarProduct(DoubleSquareMatrix m)

multiply

public AbstractDoubleVector multiply(AbstractDoubleVector v)

Returns the multiplication of a vector by this matrix.

Overrides:

multiply in class AbstractDoubleMatrix

Parameters:

v - a double vector

Throws:

DimensionException - If the matrix and vector are incompatible.

multiply

public AbstractDoubleVector multiply(DoubleSparseVector v)

Returns the multiplication of a sparse vector by this matrix.

Parameters:

v - a double vector

Throws:

DimensionException - If the matrix and vector are incompatible.

multiply

public AbstractDoubleSquareMatrix multiply(AbstractDoubleSquareMatrix m)

Returns the multiplication of this matrix and another.

Overrides:

multiply in class AbstractDoubleSquareMatrix

Parameters:

m - a double matrix

Throws:

MatrixDimensionException - If the matrices are incompatible.

multiply

public DoubleSquareMatrix multiply(DoubleSquareMatrix m)

multiply

public DoubleSparseSquareMatrix multiply(DoubleSparseSquareMatrix m)

Returns the multiplication of this matrix and another.

Parameters:

m - a double sparse matrix

Throws:

MatrixDimensionException - If the matrices are incompatible.

transpose

public Matrix transpose()

Returns the transpose of this matrix.

Overrides:

transpose in class AbstractDoubleSquareMatrix

Returns:

a double sparse matrix

luDecompose

public AbstractDoubleSquareMatrix[] luDecompose(int[] pivot)

Returns the LU decomposition of this matrix.

Overrides:

luDecompose in class AbstractDoubleSquareMatrix

Parameters:

pivot - an empty array of length rows()+1 to hold the pivot information (null if not interested)

Returns:

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

luDecompose

public AbstractDoubleSquareMatrix[] luDecompose()

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

Overrides:

luDecompose in class AbstractDoubleSquareMatrix

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.

Overrides:

choleskyDecompose in class AbstractDoubleSquareMatrix

Returns:

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

mapElements

public AbstractDoubleMatrix mapElements(Mapping f)

Applies a function on all the matrix elements.

Overrides:

mapElements in class AbstractDoubleSquareMatrix

Parameters:

f - a user-defined function

Returns:

a double sparse matrix