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

Class JSci.maths.DoubleTridiagonalMatrix

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

public class DoubleTridiagonalMatrix
extends DoubleSquareMatrix
The DoubleTridiagonalMatrix class provides an object for encapsulating tridiagonal matrices containing doubles.

Constructor Index

 o DoubleTridiagonalMatrix()
Constructs a matrix.
 o DoubleTridiagonalMatrix(double[][])
Constructs a matrix from an array.
 o DoubleTridiagonalMatrix(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 double tridiagonal matrices for equality.
 o frobeniusNorm()
Returns the Frobenius norm.
 o getElement(int, int)
Returns an element of the matrix.
 o infNorm()
Returns the l(infinity)-norm.
 o rows()
Returns the number of rows.
 o setElement(int, int, double)
Sets the value of an element of the matrix.
 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 trace()
Returns the trace.

Constructors

 o DoubleTridiagonalMatrix
  protected DoubleTridiagonalMatrix()
Constructs a matrix.
 o DoubleTridiagonalMatrix
  public DoubleTridiagonalMatrix(int size)
Constructs an empty matrix.
Parameters:
size - the number of rows/columns
 o DoubleTridiagonalMatrix
  public DoubleTridiagonalMatrix(double 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 double tridiagonal matrices for equality.
Parameters:
m - a double tridiagonal matrix
Overrides:
equals in class DoubleMatrix
 o clone
  public Object clone()
Creates a clone of this matrix.
Returns:
a copy of this matrix.
Overrides:
clone in class DoubleSquareMatrix
 o toString
  public String toString()
Returns a string representing this matrix.
Overrides:
toString in class DoubleMatrix
 o toIntegerMatrix
  public IntegerMatrix toIntegerMatrix()
Converts this matrix to an integer matrix.
Returns:
an integer tridiagonal matrix
Overrides:
toIntegerMatrix in class DoubleMatrix
 o toComplexMatrix
  public ComplexMatrix toComplexMatrix()
Converts this matrix to a complex matrix.
Returns:
a complex tridiagonal matrix
Overrides:
toComplexMatrix in class DoubleMatrix
 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.
Overrides:
getElement in class DoubleMatrix
 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.
Overrides:
setElement in class DoubleMatrix
 o trace
  public double trace()
Returns the trace.
Overrides:
trace in class DoubleSquareMatrix
 o infNorm
  public double infNorm()
Returns the l(infinity)-norm.
Overrides:
infNorm in class DoubleMatrix
 o frobeniusNorm
  public double frobeniusNorm()
Returns the Frobenius norm.
Overrides:
frobeniusNorm in class DoubleMatrix
 o rows
  public int rows()
Returns the number of rows.
Overrides:
rows in class DoubleMatrix
 o columns
  public int columns()
Returns the number of columns.
Overrides:
columns in class DoubleMatrix

All Packages  Class Hierarchy  This Package  Previous  Next  Index