DiagonalMatrixQualifier#

class nvmath.linalg.DiagonalMatrixQualifier[source]#

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

Examples

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

Create a diagonal matrix qualifier:

>>> DiagonalMatrixQualifier.create()  
array(('dg', False, False, 2, 0, 1),
      dtype=[('abbreviation', '<U2'), ('conjugate', '?'), ...

Create a conjugate diagonal matrix qualifier:

>>> DiagonalMatrixQualifier.create(conjugate=True)  
array(('dg', True, False, 2, 0, 1),
      dtype=[('abbreviation', '<U2'), ('conjugate', '?'), ...

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

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