org.jscience.mathematics.algebraic.matrices
Class DoubleMatrix

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

All Implemented Interfaces:

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

public class DoubleMatrix
extends AbstractDoubleMatrix
implements java.lang.Cloneable, java.io.Serializable

The DoubleMatrix class provides an object for encapsulating double matrices.

See Also:

Serialized Form

Field Summary

protected double[][]

matrix Array containing the elements of the matrix.

Constructor Summary

DoubleMatrix(AbstractDoubleVector[] array)
Constructs a matrix from an array of vectors (columns).

DoubleMatrix(double[][] array)
Constructs a matrix by wrapping an array.

DoubleMatrix(DoubleMatrix mat)
Copy constructor.

DoubleMatrix(int rows, int cols)
Constructs an empty matrix.

Method Summary

AbstractDoubleMatrix	add(AbstractDoubleMatrix m) Returns the addition of this matrix and another.
java.lang.Object	clone() Clone matrix into a new matrix.
AbstractDoubleMatrix	directSum(AbstractDoubleMatrix m) Returns the direct sum of this matrix and another.
boolean	equals(AbstractDoubleMatrix m, double tol) Compares two ${nativeTyp} matrices for equality.
double	frobeniusNorm() Returns the Frobenius or Hilbert-Schmidt (l2) norm.
AbstractDoubleVector	getColumn(int j) Returns the ith column.
double	getPrimitiveElement(int i, int j) Returns an element of the matrix.
AbstractDoubleVector	getRow(int i) Returns the ith row.
double	infNorm() Returns the l-norm.
AbstractDoubleMatrix	mapElements(PrimitiveMapping f) Applies a function on all the matrix elements.
AbstractDoubleMatrix	multiply(AbstractDoubleMatrix m) Returns the multiplication of this matrix and another.
AbstractDoubleVector	multiply(AbstractDoubleVector v) Returns the multiplication of a vector by this matrix.
AbstractDoubleMatrix	multiply(DoubleMatrix m)
AbelianGroup.Member	negate() Returns the negative 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(DoubleMatrix m)
void	setAllElements(double m) 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.
AbstractDoubleMatrix	subtract(AbstractDoubleMatrix m) Returns the subtraction of this matrix by another.
AbstractDoubleMatrix	tensorProduct(AbstractDoubleMatrix 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[][]	toPrimitiveArray() Projects the matrix to an array.
java.lang.String	toString() Returns a string representing this matrix.
Matrix	transpose() Returns the transpose of this matrix.

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

abs, add, equals, equals, getElement, getMatrixAsColumns, getMatrixAsRows, getSet, getSubMatrix, hashCode, horizontalAxisSymmetry, mass, max, mean, min, multiply, read, reverse, scalarDivide, scalarMultiply, setColumn, setRow, setSubMatrix, subtract, 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.Hypermatrix

getDimensions, numDimensions, numElements, numElements, toArray

Field Detail

matrix

protected final double[][] matrix

Array containing the elements of the matrix.

Constructor Detail

DoubleMatrix

public DoubleMatrix(double[][] array)

Constructs a matrix by wrapping an array.

Parameters:

array - an assigned value

DoubleMatrix

public DoubleMatrix(int rows,
                    int cols)

Constructs an empty matrix.

DoubleMatrix

public DoubleMatrix(AbstractDoubleVector[] array)

Constructs a matrix from an array of vectors (columns).

Parameters:

array - an assigned value

DoubleMatrix

public DoubleMatrix(DoubleMatrix mat)

Copy constructor.

Parameters:

mat - an assigned value

Method Detail

equals

public boolean equals(AbstractDoubleMatrix m,
                      double tol)

Compares two ${nativeTyp} matrices for equality.

Overrides:

equals in class AbstractDoubleMatrix

Parameters:

m - a double matrix

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 AbstractDoubleMatrix

Returns:

an integer matrix

toComplexMatrix

public AbstractComplexMatrix toComplexMatrix()

Converts this matrix to a complex matrix.

Overrides:

toComplexMatrix in class AbstractDoubleMatrix

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.

getRow

public AbstractDoubleVector getRow(int i)

Returns the ith row.

Specified by:

getRow in interface Matrix

Overrides:

getRow in class AbstractDoubleMatrix

Parameters:

i - DOCUMENT ME!

Returns:

DOCUMENT ME!

getColumn

public AbstractDoubleVector getColumn(int j)

Returns the ith column.

Specified by:

getColumn in interface Matrix

Overrides:

getColumn in class AbstractDoubleMatrix

Parameters:

j - DOCUMENT ME!

Returns:

DOCUMENT ME!

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

Sets the value of all elements of the matrix.

Overrides:

setAllElements in class AbstractDoubleMatrix

Parameters:

m - a complex element

infNorm

public double infNorm()

Returns the l-norm.

Overrides:

infNorm in class AbstractDoubleMatrix

frobeniusNorm

public double frobeniusNorm()

Returns the Frobenius or Hilbert-Schmidt (l²) norm.

Overrides:

frobeniusNorm in class AbstractDoubleMatrix

negate

public AbelianGroup.Member negate()

Returns the negative of this matrix.

Specified by:

negate in interface AbelianGroup.Member

Overrides:

negate in class AbstractDoubleMatrix

Returns:

DOCUMENT ME!

add

public AbstractDoubleMatrix add(AbstractDoubleMatrix m)

Returns the addition of this matrix and another.

Overrides:

add in class AbstractDoubleMatrix

Parameters:

m - a double matrix

Throws:

IllegalDimensionException - If the matrices are different sizes.

subtract

public AbstractDoubleMatrix subtract(AbstractDoubleMatrix m)

Returns the subtraction of this matrix by another.

Overrides:

subtract in class AbstractDoubleMatrix

Parameters:

m - a double 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 AbstractDoubleMatrix

Parameters:

x - a double.

Returns:

a double 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 matrix.

scalarProduct

public double scalarProduct(AbstractDoubleMatrix m)

Returns the scalar product of this matrix and another.

Overrides:

scalarProduct in class AbstractDoubleMatrix

Parameters:

m - a double matrix.

Throws:

IllegalDimensionException - If the matrices are different sizes.

scalarProduct

public double scalarProduct(DoubleMatrix 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 AbstractDoubleMatrix multiply(AbstractDoubleMatrix m)

Returns the multiplication of this matrix and another.

Overrides:

multiply in class AbstractDoubleMatrix

Parameters:

m - a double matrix

Returns:

a AbstractDoubleMatrix or a AbstractDoubleSquareMatrix as appropriate

Throws:

IllegalDimensionException - If the matrices are incompatible.

multiply

public AbstractDoubleMatrix multiply(DoubleMatrix m)

directSum

public AbstractDoubleMatrix directSum(AbstractDoubleMatrix m)

Returns the direct sum of this matrix and another.

Overrides:

directSum in class AbstractDoubleMatrix

tensorProduct

public AbstractDoubleMatrix tensorProduct(AbstractDoubleMatrix m)

Returns the tensor product of this matrix and another.

Overrides:

tensorProduct in class AbstractDoubleMatrix

transpose

public Matrix transpose()

Returns the transpose of this matrix.

Specified by:

transpose in interface Matrix

Overrides:

transpose in class AbstractDoubleMatrix

Returns:

a double 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 matrix to an array.

Overrides:

toPrimitiveArray in class AbstractDoubleMatrix

Returns:

an double array.