Class JSci.maths.ComplexMatrix
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class JSci.maths.ComplexMatrix

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

public class ComplexMatrix
extends Matrix
The ComplexMatrix class provides an object for encapsulating matrices containing complex numbers.

Variable Index

 o matrix
Array containing the elements of the matrix.

Constructor Index

 o ComplexMatrix()
Constructs a matrix.
 o ComplexMatrix(Complex[][])
Constructs a matrix by wrapping an array.
 o ComplexMatrix(ComplexVector[])
Constructs a matrix from an array of vectors.
 o ComplexMatrix(int, int)
Constructs an empty matrix.

Method Index

 o clone()
Creates a clone of this matrix.
 o columns()
Returns the number of columns.
 o equals(Object)
Compares two complex matrices for equality.
 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 imag()
Returns the imaginary part of this complex matrix.
 o infNorm()
Returns the l(infinity)-norm.
 o isHermitian()
Returns true if this matrix is hermitian.
 o real()
Returns the real part of this complex matrix.
 o rows()
Returns the number of rows.
 o setElement(int, int, Complex)
Sets the value of an element of the matrix.
 o toString()
Returns a string representing this matrix.

Variables

 o matrix
  protected Complex matrix[][]
Array containing the elements of the matrix.

Constructors

 o ComplexMatrix
  protected ComplexMatrix()
Constructs a matrix.
 o ComplexMatrix
  public ComplexMatrix(int row,
                       int col)
Constructs an empty matrix.
Parameters:
row - the number of rows
col - the number of columns
 o ComplexMatrix
  public ComplexMatrix(Complex array[][])
Constructs a matrix by wrapping an array.
Parameters:
array - an assigned value
 o ComplexMatrix
  public ComplexMatrix(ComplexVector array[])
Constructs a matrix from an array of vectors.
Parameters:
array - an assigned value

Methods

 o equals
  public boolean equals(Object m)
Compares two complex matrices for equality.
Parameters:
m - a complex matrix
Overrides:
equals in class Object
 o clone
  public Object clone()
Creates a clone of this matrix.
Returns:
a copy of this matrix.
Overrides:
clone 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 isHermitian
  public boolean isHermitian()
Returns true if this matrix is hermitian.
 o real
  public DoubleMatrix real()
Returns the real part of this complex matrix.
Returns:
a double matrix
 o imag
  public DoubleMatrix imag()
Returns the imaginary part of this complex matrix.
Returns:
a double matrix
 o getElement
  public Complex 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,
                         Complex z)
Sets the value of an element of the matrix.
Parameters:
i - row index of the element
j - column index of the element
z - a complex 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

All Packages  Class Hierarchy  This Package  Previous  Next  Index