org.jscience.mathematics.algebraic.matrices
Class DoubleSparseSquareMatrix

java.lang.Object
  org.jscience.mathematics.algebraic.AbstractHypermatrix
      org.jscience.mathematics.algebraic.AbstractMatrix
          org.jscience.mathematics.algebraic.matrices.AbstractDoubleMatrix
              org.jscience.mathematics.algebraic.matrices.AbstractDoubleSquareMatrix
                  org.jscience.mathematics.algebraic.matrices.DoubleSparseSquareMatrix

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Algebra.Member, Ring.Member, AbelianGroup.Member, Hypermatrix, Matrix, Module.Member, VectorSpace.Member, SquareMatrix, Member

public class DoubleSparseSquareMatrix
extends AbstractDoubleSquareMatrix
implements java.lang.Cloneable, java.io.Serializable

The DoubleSparseSquareMatrix class provides an object for encapsulating sparse square matrices. Uses compressed row storage.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.jscience.mathematics.algebraic.matrices.AbstractDoubleSquareMatrix

LU, LUpivot

Constructor Summary

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

DoubleSparseSquareMatrix(DoubleSparseSquareMatrix mat)
Copy constructor.

DoubleSparseSquareMatrix(int size)
Constructs an empty matrix.

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) DOCUMENT ME!
AbstractDoubleSquareMatrix[]	choleskyDecompose() Returns the Cholesky decomposition of this matrix.
java.lang.Object	clone() Clone matrix into a new matrix.
double	det() Returns the determinant.
boolean	equals(AbstractDoubleSquareMatrix m, double tol) Compares two double sparse square matrices for equality.
boolean	equals(DoubleSparseSquareMatrix m) DOCUMENT ME!
boolean	equals(DoubleSparseSquareMatrix m, double tol) DOCUMENT ME!
double	frobeniusNorm() Returns the Frobenius (l2) norm.
double	getPrimitiveElement(int i, int j) Returns an element of the matrix.
double	infNorm() Returns the l-norm.
AbstractDoubleSquareMatrix[]	luDecompose(int[] pivot) Returns the LU decomposition of this matrix.
AbstractDoubleMatrix	mapElements(PrimitiveMapping 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.
DoubleSquareMatrix	multiply(DoubleSquareMatrix m) DOCUMENT ME!
AbstractDoubleMatrix	scalarDivide(double x) DOCUMENT ME!
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) DOCUMENT ME!
void	setAllElements(double x) Sets the value of all elements of the matrix.
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) DOCUMENT ME!
AbstractComplexMatrix	toComplexMatrix() Converts this matrix to a complex matrix.
AbstractIntegerMatrix	toIntegerMatrix() Converts this matrix to an integer matrix.
double[][]	toPrimitiveArray() Projects the matrix to an array.
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 org.jscience.mathematics.algebraic.matrices.AbstractDoubleSquareMatrix

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

Methods inherited from class org.jscience.mathematics.algebraic.matrices.AbstractDoubleMatrix

abs, add, directSum, equals, equals, equals, getColumn, getElement, getMatrixAsColumns, getMatrixAsRows, getRow, getSet, getSubMatrix, hashCode, horizontalAxisSymmetry, mass, max, mean, min, multiply, multiply, read, reverse, scalarDivide, scalarMultiply, setColumn, setRow, setSubMatrix, subtract, tensorProduct, verticalAxisSymmetry

Methods inherited from class org.jscience.mathematics.algebraic.AbstractMatrix

getElement, getInvalidElementMsg, numColumns, numRows, print, print, print, print, toArray, toArray

Methods inherited from class org.jscience.mathematics.algebraic.AbstractHypermatrix

getDimensions, numDimensions, numElements, numElements, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jscience.mathematics.algebraic.Matrix

getColumn, getElement, getRow, numColumns, numRows, toArray

Methods inherited from interface org.jscience.mathematics.algebraic.Hypermatrix

getDimensions, getElement, numDimensions, numElements, numElements, toArray, toArray

Constructor Detail

DoubleSparseSquareMatrix

public DoubleSparseSquareMatrix(int size)

Constructs an empty matrix.

Parameters:

size - the number of rows/columns

DoubleSparseSquareMatrix

public DoubleSparseSquareMatrix(double[][] array)

Constructs a matrix from an array.

Parameters:

array - an assigned value

Throws:

IllegalDimensionException - If the array is not square.

DoubleSparseSquareMatrix

public DoubleSparseSquareMatrix(DoubleSparseSquareMatrix mat)

Copy constructor.

Parameters:

mat - an assigned value

Method Detail

equals

public boolean equals(AbstractDoubleSquareMatrix m,
                      double tol)

Compares two double sparse square matrices for equality.

Parameters:

m - a double matrix

tol - DOCUMENT ME!

Returns:

DOCUMENT ME!

equals

public boolean equals(DoubleSparseSquareMatrix m)

DOCUMENT ME!

Parameters:

m - DOCUMENT ME!

Returns:

DOCUMENT ME!

equals

public boolean equals(DoubleSparseSquareMatrix m,
                      double tol)

DOCUMENT ME!

Parameters:

m - DOCUMENT ME!

tol - DOCUMENT ME!

Returns:

DOCUMENT ME!

toString

public java.lang.String toString()

Returns a string representing this matrix.

Overrides:

toString in class AbstractDoubleMatrix

Returns:

DOCUMENT ME!

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

getPrimitiveElement

public double getPrimitiveElement(int i,
                                  int j)

Returns an element of the matrix.

Specified by:

getPrimitiveElement in class AbstractDoubleMatrix

Parameters:

i - row index of the element

j - column index of the element

Returns:

DOCUMENT ME!

Throws:

IllegalDimensionException - 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:

IllegalDimensionException - If attempting to access an invalid element.

setAllElements

public void setAllElements(double x)

Sets the value of all elements of the matrix. You should think about using a DoubleSquareMatrix.

Overrides:

setAllElements in class AbstractDoubleMatrix

Parameters:

x - a double element

det

public double det()

Returns the determinant.

Overrides:

det in class AbstractDoubleSquareMatrix

Returns:

DOCUMENT ME!

Throws:

java.lang.ArithmeticException - DOCUMENT ME!

trace

public double trace()

Returns the trace.

Overrides:

trace in class AbstractDoubleSquareMatrix

Returns:

DOCUMENT ME!

Throws:

java.lang.ArithmeticException - DOCUMENT ME!

infNorm

public double infNorm()

Returns the l-norm.

Overrides:

infNorm in class AbstractDoubleMatrix

Returns:

DOCUMENT ME!

Throws:

java.lang.ArithmeticException - DOCUMENT ME!

frobeniusNorm

public double frobeniusNorm()

Returns the Frobenius (l²) norm.

Overrides:

frobeniusNorm in class AbstractDoubleMatrix

Returns:

DOCUMENT ME!

Throws:

java.lang.ArithmeticException - DOCUMENT ME!

add

public AbstractDoubleSquareMatrix add(AbstractDoubleSquareMatrix m)

Returns the addition of this matrix and another.

Overrides:

add in class AbstractDoubleSquareMatrix

Parameters:

m - a double matrix

Returns:

DOCUMENT ME!

Throws:

IllegalDimensionException - If the matrices are different sizes.

add

public DoubleSquareMatrix add(DoubleSquareMatrix m)

DOCUMENT ME!

Parameters:

m - DOCUMENT ME!

Returns:

DOCUMENT ME!

add

public DoubleSparseSquareMatrix add(DoubleSparseSquareMatrix m)

Returns the addition of this matrix and another.

Parameters:

m - a double sparse matrix

Returns:

DOCUMENT ME!

Throws:

IllegalDimensionException - 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

Returns:

DOCUMENT ME!

Throws:

IllegalDimensionException - If the matrices are different sizes.

subtract

public DoubleSquareMatrix subtract(DoubleSquareMatrix m)

DOCUMENT ME!

Parameters:

m - DOCUMENT ME!

Returns:

DOCUMENT ME!

subtract

public DoubleSparseSquareMatrix subtract(DoubleSparseSquareMatrix m)

Returns the addition of this matrix and another.

Parameters:

m - a double sparse matrix

Returns:

DOCUMENT ME!

Throws:

IllegalDimensionException - 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)

DOCUMENT ME!

Overrides:

scalarDivide in class AbstractDoubleSquareMatrix

Parameters:

x - DOCUMENT ME!

Returns:

DOCUMENT ME!

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.

Returns:

DOCUMENT ME!

Throws:

IllegalDimensionException - If the matrices are different sizes.

scalarProduct

public double scalarProduct(DoubleSquareMatrix m)

DOCUMENT ME!

Parameters:

m - DOCUMENT ME!

Returns:

DOCUMENT ME!

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

Returns:

DOCUMENT ME!

Throws:

IllegalDimensionException - 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

Returns:

DOCUMENT ME!

Throws:

IllegalDimensionException - If the matrices are incompatible.

multiply

public DoubleSquareMatrix multiply(DoubleSquareMatrix m)

DOCUMENT ME!

Parameters:

m - DOCUMENT ME!

Returns:

DOCUMENT ME!

multiply

public DoubleSparseSquareMatrix multiply(DoubleSparseSquareMatrix m)

Returns the multiplication of this matrix and another.

Parameters:

m - a double sparse matrix

Returns:

DOCUMENT ME!

Throws:

IllegalDimensionException - If the matrices are incompatible.

transpose

public Matrix transpose()

Returns the transpose of this matrix.

Specified by:

transpose in interface 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 numRows()+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.

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(PrimitiveMapping f)

Applies a function on all the matrix elements.

Overrides:

mapElements in class AbstractDoubleMatrix

Parameters:

f - a user-defined function

Returns:

a double sparse matrix

clone

public java.lang.Object clone()

Clone matrix into a new matrix.

Overrides:

clone in class java.lang.Object

Returns:

the cloned matrix.

toPrimitiveArray

public double[][] toPrimitiveArray()

Projects the matrix to an array.

Overrides:

toPrimitiveArray in class AbstractDoubleMatrix

Returns:

an double array.