CADETProcess.dataStructure.parameter.Matrix

class CADETProcess.dataStructure.parameter.Matrix(n_dim=None, *args, **kwargs)

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

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

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

Attributes:

n_dimint

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

Methods

cast_value(value)	Cast lists or scalars (int or float) to numpy arrays.
get_default_value(instance)	Return default values if necessary.
ty	alias of ndarray