HermitianMatrix¶

class
HermitianMatrix
(*args)¶ Hermitian Matrix.
 Available constructors:
 HermitianMatrix(dim)
Parameters:  dim : integer
The dimension of the Hermitian matrix (square matrix with dim rows and dim columns).
See also
Notes
The Hermitian matrix is filled with . It is not possible to fill the matrix from a collection of complex values (to be done later).
Methods
checkHermitian
()Check if the internal representation is really hermitian. clean
(threshold)Clean the matrix according to a specific threshold. computeCholesky
([keepIntact])Compute the Cholesky factor. conjugate
()Accessor to the conjugate complex matrix. conjugateTranspose
()Accessor to the transposed conjugate complex matrix. getClassName
()Accessor to the object’s name. getDimension
()Accessor to the matrix dimension. getId
()Accessor to the object’s id. getImplementation
(*args)Accessor to the underlying implementation. getName
()Accessor to the object’s name. getNbColumns
()Accessor to the number of columns. getNbRows
()Accessor to the number of rows. imag
()Accessor to the imaginary part. isEmpty
()Test whether the matrix is empty or not. real
()Accessor to the real part. setName
(name)Accessor to the object’s name. transpose
()Accessor to the transposed complex matrix. solveLinearSystem 
__init__
(*args)¶ Initialize self. See help(type(self)) for accurate signature.

checkHermitian
()¶ Check if the internal representation is really hermitian.

clean
(threshold)¶ Clean the matrix according to a specific threshold.
Parameters:  threshold : positive float
Numerical sample which is the collection of points stored by the history strategy.

computeCholesky
(keepIntact=True)¶ Compute the Cholesky factor.
Returns:  G :
ComplexMatrix
The Cholesky factor , i.e. the complex matrix such as is the initial matrix.
 G :

conjugate
()¶ Accessor to the conjugate complex matrix.
Returns:  N :
ComplexMatrix
The conjugate matrix of size associated with the given complex matrix such as .
 N :

conjugateTranspose
()¶ Accessor to the transposed conjugate complex matrix.
Returns:  N :
ComplexMatrix
The transposed conjugate matrix of size associated with the given complex matrix such as .
 N :

getClassName
()¶ Accessor to the object’s name.
Returns:  class_name : str
The object class name (object.__class__.__name__).

getDimension
()¶ Accessor to the matrix dimension.
Returns:  dim : integer
The dimension of the Hermitian matrix.

getId
()¶ Accessor to the object’s id.
Returns:  id : int
Internal unique identifier.

getImplementation
(*args)¶ Accessor to the underlying implementation.
Returns:  impl : Implementation
The implementation class.

getName
()¶ Accessor to the object’s name.
Returns:  name : str
The name of the object.

getNbColumns
()¶ Accessor to the number of columns.
Returns:  nc : integer
The number of columns of .

getNbRows
()¶ Accessor to the number of rows.
Returns:  nr : integer
The number of rows of .

isEmpty
()¶ Test whether the matrix is empty or not.
Returns:  isEmpty : bool
Flag telling whether the dimensions of the matrix is zero.

setName
(name)¶ Accessor to the object’s name.
Parameters:  name : str
The name of the object.

transpose
()¶ Accessor to the transposed complex matrix.
Returns:  N :
ComplexMatrix
The transposed matrix of size associated with the given complex matrix such as .
 N :