SymmetricMatrixQualifier#

class nvmath.linalg.SymmetricMatrixQualifier[source]#

A class which constructs and validates matrix_qualifiers_dtype for a symmetric matrix.

Examples

>>> import numpy as np
>>> from nvmath.linalg import (
...     SymmetricMatrixQualifier,
...     GeneralMatrixQualifier,
...     matrix_qualifiers_dtype,
... )

Create a symmetric matrix qualifier:

>>> SymmetricMatrixQualifier.create()  
array(('sy', False, False, 0, 0, 0),
      dtype=[('abbreviation', '<U2'), ('conjugate', '?'), ...

Create a conjugate symmetric matrix qualifier:

>>> SymmetricMatrixQualifier.create(conjugate=True)  
array(('sy', True, False, 0, 0, 0),
      dtype=[('abbreviation', '<U2'), ('conjugate', '?'), ...

Create an array of matrix qualifiers with one general and one symmetric matrix:

>>> qualifiers = np.full(
...     2,
...     GeneralMatrixQualifier.create(),
...     dtype=matrix_qualifiers_dtype,
... )
>>> qualifiers[1] = SymmetricMatrixQualifier.create()
>>> qualifiers  
array([('ge', False, False, 2, 0, 0), ('sy', False, False, 0, 0, 0)],
      dtype=[('abbreviation', '<U2'), ('conjugate', '?'), ...