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

Class JSci.maths.ComplexTridiagonalMatrix

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

public class ComplexTridiagonalMatrix
extends ComplexSquareMatrix
The ComplexTridiagonalMatrix class provides an object for encapsulating tridiagonal matrices containing complex numbers.

Constructor Index

 o ComplexTridiagonalMatrix()
Constructs a matrix.
 o ComplexTridiagonalMatrix(Complex[][])
Constructs a matrix from an array.
 o ComplexTridiagonalMatrix(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 tridiagonal matrices for equality.
 o frobeniusNorm()
Returns the Frobenius norm.
 o getElement(int, int)
Returns an element of the matrix.
 o imag()
Returns the imaginary part of this complex matrix.
 o infNorm()
Returns the l(infinity)-norm.
 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.
 o trace()
Returns the trace.

Constructors

 o ComplexTridiagonalMatrix
  protected ComplexTridiagonalMatrix()
Constructs a matrix.
 o ComplexTridiagonalMatrix
  public ComplexTridiagonalMatrix(int size)
Constructs an empty matrix.
Parameters:
size - the number of rows/columns
 o ComplexTridiagonalMatrix
  public ComplexTridiagonalMatrix(Complex array[][])
Constructs a matrix from an array.
Parameters:
array - an assigned value
Throws: MatrixDimensionException
If the array is not square.

Methods

 o equals
  public boolean equals(Object m)
Compares two complex tridiagonal matrices for equality.
Parameters:
m - a complex tridiagonal matrix
Overrides:
equals in class ComplexMatrix
 o clone
  public Object clone()
Creates a clone of this matrix.
Returns:
a copy of this matrix.
Overrides:
clone in class ComplexSquareMatrix
 o toString
  public String toString()
Returns a string representing this matrix.
Overrides:
toString in class ComplexMatrix
 o real
  public DoubleMatrix real()
Returns the real part of this complex matrix.
Returns:
a double tridiagonal matrix
Overrides:
real in class ComplexMatrix
 o imag
  public DoubleMatrix imag()
Returns the imaginary part of this complex matrix.
Returns:
a double tridiagonal matrix
Overrides:
imag in class ComplexMatrix
 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.
Overrides:
getElement in class ComplexMatrix
 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.
Overrides:
setElement in class ComplexMatrix
 o trace
  public Complex trace()
Returns the trace.
Overrides:
trace in class ComplexSquareMatrix
 o infNorm
  public double infNorm()
Returns the l(infinity)-norm.
Overrides:
infNorm in class ComplexMatrix
 o frobeniusNorm
  public double frobeniusNorm()
Returns the Frobenius norm.
Overrides:
frobeniusNorm in class ComplexMatrix
 o rows
  public int rows()
Returns the number of rows.
Overrides:
rows in class ComplexMatrix
 o columns
  public int columns()
Returns the number of columns.
Overrides:
columns in class ComplexMatrix

All Packages  Class Hierarchy  This Package  Previous  Next  Index