HermitianMatrixQualifier#
-
class nvmath.
linalg. HermitianMatrixQualifier[source]# A class which constructs and validates
matrix_qualifiers_dtypefor a hermitian matrix.Examples
>>> import numpy as np >>> from nvmath.linalg import ( ... HermitianMatrixQualifier, ... GeneralMatrixQualifier, ... matrix_qualifiers_dtype, ... )
Create a hermitian matrix qualifier:
>>> HermitianMatrixQualifier.create() array(('he', False, False, 0, 0, 0), dtype=[('abbreviation', '<U2'), ('conjugate', '?'), ...
Create a conjugate hermitian matrix qualifier:
>>> HermitianMatrixQualifier.create(conjugate=True) array(('he', True, False, 0, 0, 0), dtype=[('abbreviation', '<U2'), ('conjugate', '?'), ...
Create an array of matrix qualifiers with one general and one hermitian matrix:
>>> qualifiers = np.full( ... 2, ... GeneralMatrixQualifier.create(), ... dtype=matrix_qualifiers_dtype, ... ) >>> qualifiers[1] = HermitianMatrixQualifier.create() >>> qualifiers array([('ge', False, False, 2, 0, 0), ('he', False, False, 0, 0, 0)], dtype=[('abbreviation', '<U2'), ('conjugate', '?'), ...
See also
GeneralMatrixQualifier,HermitianMatrixQualifier,SymmetricMatrixQualifier,TriangularMatrixQualifierDiagonalMatrixQualifier,matrix_qualifiers_dtypeMethods
- classmethod create( )[source]#
Return a
np.ndarrayof typematrix_qualifiers_dtypewhose element describes a hermitian matrix.- Parameters:
conjugate – Whether the matrix is conjugate.
transpose – Whether the matrix is transpose.
uplo – The
FillModeof the matrix. e.g. upper, lower…
- classmethod is_valid(other)[source]#
Return
Trueif all elements ofotherare valid examples of thematrix_qualifiers_dtypeconstructed by this class.
Attributes