org.jscience.mathematics.algebraic.matrices
Class DoubleDiagonalMatrix

java.lang.Object
  extended by org.jscience.mathematics.algebraic.AbstractHypermatrix
      extended by org.jscience.mathematics.algebraic.AbstractMatrix
          extended by org.jscience.mathematics.algebraic.matrices.AbstractDoubleMatrix
              extended by org.jscience.mathematics.algebraic.matrices.AbstractDoubleSquareMatrix
                  extended by org.jscience.mathematics.algebraic.matrices.DoubleDiagonalMatrix
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, Algebra.Member, BandedMatrix, DiagonalMatrix, Ring.Member, AbelianGroup.Member, Hypermatrix, Matrix, Module.Member, VectorSpace.Member, SquareMatrix, TridiagonalMatrix, Member

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

The DoubleDiagonalMatrix class provides an object for encapsulating double diagonal matrices.

See Also:
Serialized Form

Field Summary
protected  double[] diag
          Diagonal data.
 
Fields inherited from class org.jscience.mathematics.algebraic.matrices.AbstractDoubleSquareMatrix
LU, LUpivot
 
Constructor Summary
DoubleDiagonalMatrix(double[] array)
          Constructs a matrix by wrapping an array containing the diagonal elements.
DoubleDiagonalMatrix(double[][] array)
          Constructs a matrix from an array.
DoubleDiagonalMatrix(DoubleDiagonalMatrix mat)
          Copy constructor.
DoubleDiagonalMatrix(int size)
          Constructs an empty matrix.
 
Method Summary
 AbstractDoubleSquareMatrix add(AbstractDoubleSquareMatrix m)
          Returns the addition of this matrix and another.
 DoubleDiagonalMatrix add(DoubleDiagonalMatrix m)
          Returns the addition of this matrix and another.
 DoubleSquareMatrix add(DoubleSquareMatrix m)
           
 DoubleTridiagonalMatrix add(DoubleTridiagonalMatrix m)
          Returns the addition of this matrix and another.
 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(AbstractDoubleMatrix m, double tol)
          Compares two ${nativeTyp} matrices for equality.
 double frobeniusNorm()
          Returns the Frobenius (l2) norm.
 int getK1()
          DOCUMENT ME!
 int getK2()
          DOCUMENT ME!
 double getPrimitiveElement(int i, int j)
          Returns an element of the matrix.
static DoubleDiagonalMatrix identity(int size)
          Creates an identity matrix.
 double infNorm()
          Returns the linfinity-norm.
 AbstractDoubleSquareMatrix inverse()
          Returns the inverse of this matrix.
 boolean isSymmetric()
          Returns true if this matrix is symmetric.
 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.
 DoubleDiagonalMatrix multiply(DoubleDiagonalMatrix m)
           
 DoubleSquareMatrix multiply(DoubleSquareMatrix m)
           
 DoubleTridiagonalMatrix multiply(DoubleTridiagonalMatrix m)
           
 double operatorNorm()
          Returns the operator norm.
 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(AbstractDoubleSquareMatrix m)
          Returns the scalar product of this matrix and another.
 double scalarProduct(DoubleDiagonalMatrix m)
           
 double scalarProduct(DoubleSquareMatrix m)
           
 double scalarProduct(DoubleTridiagonalMatrix m)
           
 void setAllElements(double r)
          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[] singularValueDecompose()
          Returns the singular value decomposition of this matrix.
 AbstractDoubleSquareMatrix subtract(AbstractDoubleSquareMatrix m)
          Returns the subtraction of this matrix by another.
 DoubleDiagonalMatrix subtract(DoubleDiagonalMatrix m)
          Returns the subtraction of this matrix and another.
 DoubleSquareMatrix subtract(DoubleSquareMatrix m)
           
 DoubleTridiagonalMatrix subtract(DoubleTridiagonalMatrix m)
          Returns the subtraction of this matrix and another.
 AbstractComplexMatrix toComplexMatrix()
          Converts this matrix to a complex matrix.
 AbstractIntegerMatrix toIntegerMatrix()
          Converts this matrix to an integer matrix.
 double[][] toPrimitiveArray()
          Projects the vector 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, isUnitary, negate, polarDecompose, scalarProduct, subtract, tensorProduct
 
Methods inherited from class org.jscience.mathematics.algebraic.matrices.AbstractDoubleMatrix
abs, add, directSum, 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
 

Field Detail

diag

protected final double[] diag
Diagonal data.

Constructor Detail

DoubleDiagonalMatrix

public DoubleDiagonalMatrix(int size)
Constructs an empty matrix.

Parameters:
size - the number of rows/columns

DoubleDiagonalMatrix

public DoubleDiagonalMatrix(double[][] array)
Constructs a matrix from an array. Any non-diagonal elements in the array are ignored.

Parameters:
array - an assigned value
Throws:
IllegalDimensionException - If the array is not square.

DoubleDiagonalMatrix

public DoubleDiagonalMatrix(double[] array)
Constructs a matrix by wrapping an array containing the diagonal elements.

Parameters:
array - an assigned value

DoubleDiagonalMatrix

public DoubleDiagonalMatrix(DoubleDiagonalMatrix mat)
Copy constructor.

Parameters:
mat - an assigned value
Method Detail

identity

public static DoubleDiagonalMatrix identity(int size)
Creates an identity matrix.

Parameters:
size - the number of rows/columns

equals

public boolean equals(AbstractDoubleMatrix m,
                      double tol)
Compares two ${nativeTyp} matrices for equality.

Overrides:
equals in class AbstractDoubleMatrix
Parameters:
m - a double matrix

getK1

public int getK1()
Description copied from interface: BandedMatrix
DOCUMENT ME!

Specified by:
getK1 in interface BandedMatrix
Returns:
DOCUMENT ME!

getK2

public int getK2()
Description copied from interface: BandedMatrix
DOCUMENT ME!

Specified by:
getK2 in interface BandedMatrix
Returns:
DOCUMENT ME!

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 matrix

toComplexMatrix

public AbstractComplexMatrix toComplexMatrix()
Converts this matrix to a complex matrix.

Overrides:
toComplexMatrix in class AbstractDoubleSquareMatrix
Returns:
a complex 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
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. Should only be used to initialise this 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 r)
Sets the value of all elements of the matrix. This method will throw an error unless the paramter is 0. This is because you need a SquareMatrix to set all the contents of the matrix to a value. You should think about using a DoubleSquareMatrix.

Overrides:
setAllElements in class AbstractDoubleMatrix
Parameters:
r - a Complex element

isSymmetric

public boolean isSymmetric()
Returns true if this matrix is symmetric.

Specified by:
isSymmetric in interface SquareMatrix
Overrides:
isSymmetric in class AbstractDoubleSquareMatrix
Returns:
DOCUMENT ME!

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 linfinity-norm.

Overrides:
infNorm in class AbstractDoubleMatrix

frobeniusNorm

public double frobeniusNorm()
Returns the Frobenius (l2) norm.

Overrides:
frobeniusNorm in class AbstractDoubleMatrix

operatorNorm

public double operatorNorm()
                    throws MaximumIterationsExceededException
Returns the operator norm.

Overrides:
operatorNorm in class AbstractDoubleSquareMatrix
Throws:
MaximumIterationsExceededException - If it takes more than 50 iterations to determine an eigenvalue.

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:
IllegalDimensionException - If the matrices are different sizes.

add

public DoubleSquareMatrix add(DoubleSquareMatrix m)

add

public DoubleTridiagonalMatrix add(DoubleTridiagonalMatrix m)
Returns the addition of this matrix and another.

Parameters:
m - a double tridiagonal matrix
Throws:
IllegalDimensionException - If the matrices are different sizes.

add

public DoubleDiagonalMatrix add(DoubleDiagonalMatrix m)
Returns the addition of this matrix and another.

Parameters:
m - a double diagonal matrix
Throws:
IllegalDimensionException - If the matrices are different sizes.

subtract

public AbstractDoubleSquareMatrix subtract(AbstractDoubleSquareMatrix m)
Returns the subtraction of this matrix by another.

Overrides:
subtract in class AbstractDoubleSquareMatrix
Parameters:
m - a double matrix
Throws:
IllegalDimensionException - If the matrices are different sizes.

subtract

public DoubleSquareMatrix subtract(DoubleSquareMatrix m)

subtract

public DoubleTridiagonalMatrix subtract(DoubleTridiagonalMatrix m)
Returns the subtraction of this matrix and another.

Parameters:
m - a double tridiagonal matrix
Throws:
IllegalDimensionException - If the matrices are different sizes.

subtract

public DoubleDiagonalMatrix subtract(DoubleDiagonalMatrix m)
Returns the subtraction of this matrix and another.

Parameters:
m - a double diagonal matrix
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 diagonal matrix.

scalarDivide

public AbstractDoubleMatrix scalarDivide(double x)
Returns the division of this matrix by a scalar.

Overrides:
scalarDivide in class AbstractDoubleSquareMatrix
Parameters:
x - a double.
Returns:
a double diagonal 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:
IllegalDimensionException - If the matrices are different sizes.

scalarProduct

public double scalarProduct(DoubleSquareMatrix m)

scalarProduct

public double scalarProduct(DoubleTridiagonalMatrix m)

scalarProduct

public double scalarProduct(DoubleDiagonalMatrix 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:
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:
a AbstractDoubleMatrix or a AbstractDoubleSquareMatrix as appropriate
Throws:
IllegalDimensionException - If the matrices are incompatible.

multiply

public DoubleSquareMatrix multiply(DoubleSquareMatrix m)

multiply

public DoubleTridiagonalMatrix multiply(DoubleTridiagonalMatrix m)

multiply

public DoubleDiagonalMatrix multiply(DoubleDiagonalMatrix m)

transpose

public Matrix transpose()
Returns the transpose of this matrix.

Specified by:
transpose in interface Matrix
Overrides:
transpose in class AbstractDoubleSquareMatrix
Returns:
a double matrix

inverse

public AbstractDoubleSquareMatrix inverse()
Returns the inverse of this matrix.

Overrides:
inverse in class AbstractDoubleSquareMatrix
Returns:
a double diagonal 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). The last array element will contain the parity.
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.

qrDecompose

public AbstractDoubleSquareMatrix[] qrDecompose()
Returns the QR decomposition of this matrix.

Overrides:
qrDecompose in class AbstractDoubleSquareMatrix
Returns:
an array with [0] containing the Q-matrix and [1] containing the R-matrix.

singularValueDecompose

public AbstractDoubleSquareMatrix[] singularValueDecompose()
Returns the singular value decomposition of this matrix.

Overrides:
singularValueDecompose in class AbstractDoubleSquareMatrix
Returns:
an array with [0] containing the U-matrix, [1] containing the S-matrix and [2] containing the V-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 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 vector to an array.

Overrides:
toPrimitiveArray in class AbstractDoubleMatrix
Returns:
a Complex array.