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.
-
basex
- The base index
-
bx
- The base index
-
CHOL
- Points to a Cholesky decompoistion of the matrix
provided one exists
-
cx
- The upper column index
-
dirty
- True if the matrix has been altered
-
HQR
- Points to a Householder QR decompoistion of the matrix
provided one exists
-
im
- The imaginary part of the matrix
-
LU
- Points to an LU decompoistion of the matrix
provided one exists
-
nc
- The number of columns
-
ncol
- The number of columns
-
nr
- The number of rows
-
nrow
- The number of rows
-
re
- The real part of the matrix
-
rx
- The upper row index
-
Zmat(double[][])
- Creates a Zmat and initializes its real part to
to an array of class double.
-
Zmat(double[][], double[][])
- Creates a Zmat and initializes its real and imaginary
parts to a pair of arrays.
-
Zmat(int, int)
- Creates a Zmat and initializes it to zero.
-
Zmat(Z1)
- Creates a Zmat and initialize it to a Z1.
-
Zmat(Z[][])
- Creates a Zmat and initializes it to an array of class Z.
-
Zmat(Zdiagmat)
- Creates a Zmat and initialize it to a Zdiagmat.
-
Zmat(Zmat)
- Creates a Zmat and intitializes it to a Zmat.
-
clean()
- Nullifies the history pointers if the matrix is dirty
and sets the dirty flag to false.
-
get(int, int)
- Returns the (ii,jj)-element of a Zmat.
-
get(int, int, int, int)
- Returns the submatrix (ii1:ii2, jj1:jj2).
-
get(int, int, int[])
- Returns the submatrix (ii1:ii2, jj[]).
-
get(int[], int, int)
- Returns the submatrix (ii[], jj1:jj2).
-
get(int[], int[])
- Returns the submatrix (ii[], jj[]).
-
get0(int, int)
- Returns the zero-based (i,j)-element of a Zmat.
-
getCHOL()
- Returns a Cholesky decomposition if a valid one exists.
-
getHQR()
- Returns a Householder QR decomposition if a valid one exists.
-
getIm()
- Returns a copy of the imaginary part of a Zmat.
-
getLU()
- Returns an LU decomposition if a valid one exists.
-
getProperties()
- Sets the public parameters.
-
getRe()
- Returns a copy of the real part of a Zmat.
-
getZ()
- Returns a copy of the real and imaginary parts as a complex array.
-
put(int, int, int, int, Zmat)
- Overwrites the submatrix (ii1:ii2, jj1:jj2) with a Zmat.
-
put(int, int, int[], Zmat)
- Overwrites the submatrix (ii1:ii2, jj[]) with a Zmat.
-
put(int, int, Z)
- Writes the (ii,jj) element of a Zmat.
-
put(int[], int, int, Zmat)
- Overwrites the submatrix (ii[], jj1:jj2) with a Zmat.
-
put(int[], int[], Zmat)
- Overwrites the submatrix (ii[], jj[]) with a Zmat.
-
put0(int, int, Z)
- Writes the zero-based (i,j)-element of a Zmat.
nrow
protected int nrow
- The number of rows
ncol
protected int ncol
- The number of columns
basex
protected int basex
- The base index
re
protected double re[][]
- The real part of the matrix
im
protected double im[][]
- The imaginary part of the matrix
dirty
protected boolean dirty
- True if the matrix has been altered
LU
protected Zludpp LU
- Points to an LU decompoistion of the matrix
provided one exists
HQR
protected Zhqrd HQR
- Points to a Householder QR decompoistion of the matrix
provided one exists
CHOL
protected Zchol CHOL
- Points to a Cholesky decompoistion of the matrix
provided one exists
bx
public int bx
- The base index
rx
public int rx
- The upper row index
nr
public int nr
- The number of rows
cx
public int cx
- The upper column index
nc
public int nc
- The number of columns
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
Zmat
public Zmat(Z A[][])
- Creates a Zmat and initializes it to an array of class Z.
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.
Zmat
public Zmat(Zmat A)
- Creates a Zmat and intitializes it to a Zmat.
Zmat
public Zmat(Z1 A)
- Creates a Zmat and initialize it to a Z1.
Zmat
public Zmat(Zdiagmat D)
- Creates a Zmat and initialize it to a Zdiagmat.
Zmat
public Zmat(int nrow,
int ncol)
- Creates a Zmat and initializes it to zero.
getProperties
public void getProperties()
- Sets the public parameters.
getRe
public double[][] getRe()
- Returns a copy of the real part of a Zmat.
getIm
public double[][] getIm()
- Returns a copy of the imaginary part of a Zmat.
getZ
public Z[][] getZ()
- Returns a copy of the real and imaginary parts as a complex array.
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
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
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
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
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
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
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
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.
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
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
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
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
getLU
public Zludpp getLU()
- Returns an LU decomposition if a valid one exists. Otherwise
returns null.
getHQR
public Zhqrd getHQR()
- Returns a Householder QR decomposition if a valid one exists.
Otherwise returns null.
getCHOL
public Zchol getCHOL()
- Returns a Cholesky decomposition if a valid one exists.
Otherwise returns null.
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