All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class Jampack.Zdiagmat

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

public class Zdiagmat
extends Object
Zdiagmat is a storage efficient representation of a complex diagonal matrix.


Variable Index

 o basex
The base index
 o bx
The base index (public)
 o dx
The index of the last diagonal (public)
 o im
The imaginary part of the diagonal
 o n
The order of the matrix (public)
 o order
The order of the matrix
 o re
The real part of the diagonal

Constructor Index

 o Zdiagmat(int)
Constructs a Zdiagmat and initializes it to zero.
 o Zdiagmat(int, Z)
Constructs a Zdiagmat and initializes it to a constant.
 o Zdiagmat(Z1)
Constructs a Zdiagmat and initializes it to a Z1.
 o Zdiagmat(Zdiagmat)
Constructs a Zdiagmat and initializes it to another Zdiagmat.
 o Zdiagmat(Zmat)
Constructs a Zdiagmat and initializes it to the principal diagonal of a Zmat.
 o Zdiagmat(Zmat, int)
Constructs a Zdiagmat and initializes it to the diagonal of a Zmat.

Method Index

 o get(int)
Gets the ii-th diagonal element of a Zdiagmat.
 o get0(int)
Gets the ith diagonal of a of a Zdiagmat (0-based).
 o getProperties()
Sets the public parameters.
 o put(int, Z)
Writes the ii-th diagonal element of a Zdiagmat.
 o put0(int, Z)
Writes the ith diagonal element of a Zdiagmat (0-based).

Variables

 o order
 protected int order
The order of the matrix

 o basex
 protected int basex
The base index

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

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

 o n
 public int n
The order of the matrix (public)

 o bx
 public int bx
The base index (public)

 o dx
 public int dx
The index of the last diagonal (public)

Constructors

 o Zdiagmat
 public Zdiagmat(int order)
Constructs a Zdiagmat and initializes it to zero.

Parameters:
order - The order of the new Zdiagmat
Returns:
A Zdiagmat initialized to zero.
 o Zdiagmat
 public Zdiagmat(int order,
                 Z val)
Constructs a Zdiagmat and initializes it to a constant.

Parameters:
order - The order of the new Zdiagmat
val - The value to which the diagonal is to be initialized
Returns:
A Zdiagmat whose diagonal is val.
 o Zdiagmat
 public Zdiagmat(Z1 val)
Constructs a Zdiagmat and initializes it to a Z1.

Parameters:
val - A Z1
Returns:
A Zdiagmat whose diagonal elements are the elements of val.
 o Zdiagmat
 public Zdiagmat(Zmat A,
                 int k) throws JampackException
Constructs a Zdiagmat and initializes it to the diagonal of a Zmat.

Parameters:
A - The Zmat
k - The diagonal. For k=0 gives the princpal diagonal; k>0, the kth superdiagonal; k<0, the kth subdiagonal.
Returns:
The Zdiagmat consisting of the selected diagonal of A
Throws: JampackException
Thrown for k to large or small.
 o Zdiagmat
 public Zdiagmat(Zmat A) throws JampackException
Constructs a Zdiagmat and initializes it to the principal diagonal of a Zmat.

Parameters:
A - A Zmat
Returns:
s A Zdiagmat whose diagonal is that of A
Throws: JampackException
Passed from below.
 o Zdiagmat
 public Zdiagmat(Zdiagmat D)
Constructs a Zdiagmat and initializes it to another Zdiagmat.

Parameters:
D - A Zdiagmat
Returns:
s A Zdiagmat that is a copy of D.

Methods

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

 o get
 public Z get(int ii)
Gets the ii-th diagonal element of a Zdiagmat.

Parameters:
ii - An integer
Returns:
The ii-th element of this Zdiagmat
 o get0
 public Z get0(int i)
Gets the ith diagonal of a of a Zdiagmat (0-based).

 o put
 public void put(int ii,
                 Z val)
Writes the ii-th diagonal element of a Zdiagmat.

Parameters:
ii - An integer
val - A Z
Returns:
Resets the ii-th diagonal element of this Zdiagmat to val.
 o put0
 public void put0(int i,
                  Z val)
Writes the ith diagonal element of a Zdiagmat (0-based).


All Packages  Class Hierarchy  This Package  Previous  Next  Index