All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class Jampack.Zmat

java.lang.Object
   |
   +----Jampack.Zmat

public class Zmat
extends Object
Zmat implements general complex matrix stored in a rectangular array class Z.


Variable Index

 o basex
The base index
 o bx
The base index
 o CHOL
Points to a Cholesky decompoistion of the matrix provided one exists
 o cx
The upper column index
 o dirty
True if the matrix has been altered
 o HQR
Points to a Householder QR decompoistion of the matrix provided one exists
 o im
The imaginary part of the matrix
 o LU
Points to an LU decompoistion of the matrix provided one exists
 o nc
The number of columns
 o ncol
The number of columns
 o nr
The number of rows
 o nrow
The number of rows
 o re
The real part of the matrix
 o rx
The upper row index

Constructor Index

 o Zmat(double[][])
Creates a Zmat and initializes its real part to to an array of class double.
 o Zmat(double[][], double[][])
Creates a Zmat and initializes its real and imaginary parts to a pair of arrays.
 o Zmat(int, int)
Creates a Zmat and initializes it to zero.
 o Zmat(Z1)
Creates a Zmat and initialize it to a Z1.
 o Zmat(Z[][])
Creates a Zmat and initializes it to an array of class Z.
 o Zmat(Zdiagmat)
Creates a Zmat and initialize it to a Zdiagmat.
 o Zmat(Zmat)
Creates a Zmat and intitializes it to a Zmat.

Method Index

 o clean()
Nullifies the history pointers if the matrix is dirty and sets the dirty flag to false.
 o get(int, int)
Returns the (ii,jj)-element of a Zmat.
 o get(int, int, int, int)
Returns the submatrix (ii1:ii2, jj1:jj2).
 o get(int, int, int[])
Returns the submatrix (ii1:ii2, jj[]).
 o get(int[], int, int)
Returns the submatrix (ii[], jj1:jj2).
 o get(int[], int[])
Returns the submatrix (ii[], jj[]).
 o get0(int, int)
Returns the zero-based (i,j)-element of a Zmat.
 o getCHOL()
Returns a Cholesky decomposition if a valid one exists.
 o getHQR()
Returns a Householder QR decomposition if a valid one exists.
 o getIm()
Returns a copy of the imaginary part of a Zmat.
 o getLU()
Returns an LU decomposition if a valid one exists.
 o getProperties()
Sets the public parameters.
 o getRe()
Returns a copy of the real part of a Zmat.
 o getZ()
Returns a copy of the real and imaginary parts as a complex array.
 o put(int, int, int, int, Zmat)
Overwrites the submatrix (ii1:ii2, jj1:jj2) with a Zmat.
 o put(int, int, int[], Zmat)
Overwrites the submatrix (ii1:ii2, jj[]) with a Zmat.
 o put(int, int, Z)
Writes the (ii,jj) element of a Zmat.
 o put(int[], int, int, Zmat)
Overwrites the submatrix (ii[], jj1:jj2) with a Zmat.
 o put(int[], int[], Zmat)
Overwrites the submatrix (ii[], jj[]) with a Zmat.
 o put0(int, int, Z)
Writes the zero-based (i,j)-element of a Zmat.

Variables

 o nrow
 protected int nrow
The number of rows

 o ncol
 protected int ncol
The number of columns

 o basex
 protected int basex
The base index

 o re
 protected double re[][]
The real part of the matrix

 o im
 protected double im[][]
The imaginary part of the matrix

 o dirty
 protected boolean dirty
True if the matrix has been altered

 o LU
 protected Zludpp LU
Points to an LU decompoistion of the matrix provided one exists

 o HQR
 protected Zhqrd HQR
Points to a Householder QR decompoistion of the matrix provided one exists

 o CHOL
 protected Zchol CHOL
Points to a Cholesky decompoistion of the matrix provided one exists

 o bx
 public int bx
The base index

 o rx
 public int rx
The upper row index

 o nr
 public int nr
The number of rows

 o cx
 public int cx
The upper column index

 o nc
 public int nc
The number of columns

Constructors

 o Zmat
 public Zmat(double re[][],
             double im[][]) throws JampackException
Creates a Zmat and initializes its real and imaginary parts to a pair of arrays.

Parameters:
re - Contains the real part.
im - Contains the imaginary part.
Throws: JampackException
if the dimensions of re and im do not match
 o Zmat
 public Zmat(Z A[][])
Creates a Zmat and initializes it to an array of class Z.

 o Zmat
 public Zmat(double A[][])
Creates a Zmat and initializes its real part to to an array of class double. The imaginary part is set to zero.

 o Zmat
 public Zmat(Zmat A)
Creates a Zmat and intitializes it to a Zmat.

 o Zmat
 public Zmat(Z1 A)
Creates a Zmat and initialize it to a Z1.

 o Zmat
 public Zmat(Zdiagmat D)
Creates a Zmat and initialize it to a Zdiagmat.

 o Zmat
 public Zmat(int nrow,
             int ncol)
Creates a Zmat and initializes it to zero.

Methods

 o getProperties
 public void getProperties()
Sets the public parameters.

 o getRe
 public double[][] getRe()
Returns a copy of the real part of a Zmat.

 o getIm
 public double[][] getIm()
Returns a copy of the imaginary part of a Zmat.

 o getZ
 public Z[][] getZ()
Returns a copy of the real and imaginary parts as a complex array.

 o get
 public Z get(int ii,
              int jj)
Returns the (ii,jj)-element of a Zmat.

Parameters:
ii - The row index of the element
jj - The column index of the element
 o get0
 public Z get0(int i,
               int j)
Returns the zero-based (i,j)-element of a Zmat.

Parameters:
i - The row index of the element
j - The column index of the element
 o put
 public void put(int ii,
                 int jj,
                 Z a)
Writes the (ii,jj) element of a Zmat.

Parameters:
ii - The row index of the element
jj - The column index of the element
a - The new value of the element
 o put0
 public void put0(int i,
                  int j,
                  Z a)
Writes the zero-based (i,j)-element of a Zmat.

Parameters:
i - The row index of the element
j - The column index of the element
a - The new value of the element
 o get
 public Zmat get(int ii1,
                 int ii2,
                 int jj1,
                 int jj2)
Returns the submatrix (ii1:ii2, jj1:jj2).

Parameters:
ii1 - The lower column index
ii2 - The upper column index
jj1 - The lower row index
jj2 - The upper row index
 o put
 public void put(int ii1,
                 int ii2,
                 int jj1,
                 int jj2,
                 Zmat A)
Overwrites the submatrix (ii1:ii2, jj1:jj2) with a Zmat.

Parameters:
ii1 - The lower column index
ii2 - The upper column index
jj1 - The lower row index
jj2 - The upper row index
A - The new value of the submatrix
 o get
 public Zmat get(int ii[],
                 int jj1,
                 int jj2)
Returns the submatrix (ii[], jj1:jj2).

Parameters:
i[] - Contains the row indices of the submatrix
jj1 - The lower column index
jj2 - The upper column index
 o put
 public void put(int ii[],
                 int jj1,
                 int jj2,
                 Zmat A)
Overwrites the submatrix (ii[], jj1:jj2) with a Zmat.

Parameters:
i[] - Contains the row indices of the submatrix
jj1 - The lower column index
jj2 - The upper column index
A - The new value of the submatrix.
 o get
 public Zmat get(int ii1,
                 int ii2,
                 int jj[])
Returns the submatrix (ii1:ii2, jj[]).

Parameters:
ii1 - The lower row index
ii2 - The upper row index
jj[] - Contains the column indices of the submatrix
 o put
 public void put(int ii1,
                 int ii2,
                 int jj[],
                 Zmat A)
Overwrites the submatrix (ii1:ii2, jj[]) with a Zmat.

Parameters:
ii1 - The lower row index
ii2 - The upper row index
jj[] - Contains the column indices of the submatrix
A - The new value of the submatrix
 o get
 public Zmat get(int ii[],
                 int jj[])
Returns the submatrix (ii[], jj[]).

Parameters:
ii[] - Contains the row indices of the submatrix
jj[] - Contains the column indices of the submatrix
 o put
 public void put(int ii[],
                 int jj[],
                 Zmat A)
Overwrites the submatrix (ii[], jj[]) with a Zmat. Returns the submatrix (ii[], jj[])

Parameters:
ii[] - Contains the row indices of the submatrix
jj[] - Contains the column indices of the submatrix
A - The value of the new submatrix
 o getLU
 public Zludpp getLU()
Returns an LU decomposition if a valid one exists. Otherwise returns null.

 o getHQR
 public Zhqrd getHQR()
Returns a Householder QR decomposition if a valid one exists. Otherwise returns null.

 o getCHOL
 public Zchol getCHOL()
Returns a Cholesky decomposition if a valid one exists. Otherwise returns null.

 o clean
 protected void clean()
Nullifies the history pointers if the matrix is dirty and sets the dirty flag to false.


All Packages  Class Hierarchy  This Package  Previous  Next  Index