CADETProcess.dataStructure.parameter.Matrix

Contents

CADETProcess.dataStructure.parameter.Matrix#

class CADETProcess.dataStructure.parameter.Matrix(n_dim: int | None = None, *args: Any, **kwargs: Any)[source]#

Bases: DimensionalizedArray

Parameter descriptor for two-dimensional numpy arrays (matrices).

This descriptor ensures that the ndarray assigned is two-dimensional.

Attributes:
n_dimint

Dimensionality of the numpy array, set to 2 for matrices.

See also

DimensionalizedArray
NdArray

Examples

>>> class MyModel:
...     data = Matrix()
>>> model = MyModel()
>>> model.data = np.array([[1, 2], [3, 4]])  # Valid
>>> model.data = np.array([1, 2, 3, 4])  # Raises ValueError
n_dim = 2#
Contents