All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class JSci.maths.DoubleMatrix

java.lang.Object
   |
   +----JSci.maths.Matrix
           |
           +----JSci.maths.DoubleMatrix

public class DoubleMatrix
extends Matrix
The DoubleMatrix class provides an object for encapsulating double matrix algebra.


Variable Index

 o ARRAY_2D
Storage format identifier.
 o matrix
Array containing the elements of the matrix.
 o storageFormat

Constructor Index

 o DoubleMatrix()
Constructs a matrix.
 o DoubleMatrix(double[][])
Constructs a matrix by wrapping an array.
 o DoubleMatrix(DoubleVector[])
Constructs a matrix from an array of vectors (columns).
 o DoubleMatrix(int, int)
Constructs an empty matrix.

Method Index

 o add(AbelianGroupMember)
Returns the addition of this matrix and another.
 o add(DoubleMatrix)
Returns the addition of this matrix and another.
 o columns()
Returns the number of columns.
 o equals(Object)
Compares two double matrices for equality.
 o finalize()
Finalize.
 o frobeniusNorm()
Returns the Frobenius norm.
 o getElement(int, int)
Returns an element of the matrix.
 o hashCode()
Returns a hashcode for this matrix.
 o infNorm()
Returns the l(infinity)-norm.
 o mapElements(Mapping)
Applies a function on all the matrix elements.
 o multiply(DoubleMatrix)
Returns the multiplication of this matrix and another.
 o multiply(DoubleVector)
Returns the multiplication of a vector by this matrix.
 o multiply(RingMember)
Returns the multiplication of this matrix and another.
 o negate()
Returns the negative of this matrix.
 o rows()
Returns the number of rows.
 o scalarMultiply(double)
Returns the multiplication of this matrix by a scalar.
 o scalarMultiply(RingMember)
Returns the multiplication of this matrix by a scalar.
 o setElement(int, int, double)
Sets the value of an element of the matrix.
 o subtract(AbelianGroupMember)
Returns the subtraction of this matrix by another.
 o subtract(DoubleMatrix)
Returns the subtraction of this matrix by another.
 o toComplexMatrix()
Converts this matrix to a complex matrix.
 o toIntegerMatrix()
Converts this matrix to an integer matrix.
 o toString()
Returns a string representing this matrix.
 o transpose()
Returns the transpose of this matrix.

Variables

 o ARRAY_2D
 protected static final int ARRAY_2D
Storage format identifier.

 o storageFormat
 protected static final int storageFormat
 o matrix
 protected double matrix[][]
Array containing the elements of the matrix.

Constructors

 o DoubleMatrix
 protected DoubleMatrix()
Constructs a matrix.

 o DoubleMatrix
 public DoubleMatrix(int row,
                     int col)
Constructs an empty matrix.

Parameters:
row - the number of rows
col - the number of columns
 o DoubleMatrix
 public DoubleMatrix(double array[][])
Constructs a matrix by wrapping an array.

Parameters:
array - an assigned value
 o DoubleMatrix
 public DoubleMatrix(DoubleVector array[])
Constructs a matrix from an array of vectors (columns).

Parameters:
array - an assigned value

Methods

 o finalize
 protected void finalize() throws Throwable
Finalize.

Throws: Throwable
Any that occur.
Overrides:
finalize in class Object
 o equals
 public boolean equals(Object m)
Compares two double matrices for equality.

Parameters:
m - a double matrix
Overrides:
equals in class Object
 o toString
 public String toString()
Returns a string representing this matrix.

Overrides:
toString in class Object
 o hashCode
 public int hashCode()
Returns a hashcode for this matrix.

Overrides:
hashCode in class Object
 o toIntegerMatrix
 public IntegerMatrix toIntegerMatrix()
Converts this matrix to an integer matrix.

Returns:
an integer matrix
 o toComplexMatrix
 public ComplexMatrix toComplexMatrix()
Converts this matrix to a complex matrix.

Returns:
a complex matrix
 o getElement
 public double getElement(int i,
                          int j)
Returns an element of the matrix.

Parameters:
i - row index of the element
j - column index of the element
Throws: MatrixDimensionException
If attempting to access an invalid element.
 o setElement
 public void setElement(int i,
                        int j,
                        double x)
Sets the value of an element of the matrix.

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.
 o infNorm
 public double infNorm()
Returns the l(infinity)-norm.

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

 o rows
 public int rows()
Returns the number of rows.

Overrides:
rows in class Matrix
 o columns
 public int columns()
Returns the number of columns.

Overrides:
columns in class Matrix
 o negate
 public AbelianGroupMember negate()
Returns the negative of this matrix.

Overrides:
negate in class Matrix
 o add
 public AbelianGroupMember add(AbelianGroupMember m)
Returns the addition of this matrix and another.

Overrides:
add in class Matrix
 o add
 public DoubleMatrix add(DoubleMatrix m)
Returns the addition of this matrix and another.

Parameters:
m - a double matrix
Throws: MatrixDimensionException
If the matrices are different sizes.
 o subtract
 public AbelianGroupMember subtract(AbelianGroupMember m)
Returns the subtraction of this matrix by another.

Overrides:
subtract in class Matrix
 o subtract
 public DoubleMatrix subtract(DoubleMatrix m)
Returns the subtraction of this matrix by another.

Parameters:
m - a double matrix
Throws: MatrixDimensionException
If the matrices are different sizes.
 o scalarMultiply
 public AlgebraMember scalarMultiply(RingMember x)
Returns the multiplication of this matrix by a scalar.

Overrides:
scalarMultiply in class Matrix
 o scalarMultiply
 public DoubleMatrix scalarMultiply(double x)
Returns the multiplication of this matrix by a scalar.

Parameters:
x - a double
Returns:
a double matrix
 o multiply
 public DoubleVector multiply(DoubleVector v)
Returns the multiplication of a vector by this matrix.

Parameters:
v - a double vector
Throws: DimensionException
If the matrix and vector are incompatible.
 o multiply
 public RingMember multiply(RingMember m)
Returns the multiplication of this matrix and another.

Overrides:
multiply in class Matrix
 o multiply
 public DoubleMatrix multiply(DoubleMatrix m)
Returns the multiplication of this matrix and another.

Parameters:
m - a double matrix
Returns:
a DoubleMatrix or a DoubleSquareMatrix as appropriate
Throws: MatrixDimensionException
If the matrices are incompatible.
 o transpose
 public Matrix transpose()
Returns the transpose of this matrix.

Returns:
a double matrix
Overrides:
transpose in class Matrix
 o mapElements
 public DoubleMatrix mapElements(Mapping f)
Applies a function on all the matrix elements.

Parameters:
f - a user-defined function
Returns:
a double matrix

All Packages  Class Hierarchy  This Package  Previous  Next  Index