CADETProcess.dataStructure.parameter.Vector

Contents

CADETProcess.dataStructure.parameter.Vector#

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

Parameter descriptor for one-dimensional numpy arrays (vectors).

Attributes:
n_dimint

Dimensionality of the numpy array, set to 1 for vectors.

Methods

cast_value(value)

Cast lists or scalars (int or float) to numpy arrays.

get_default_value(instance)

Return default values if necessary.

ty

See also

Dimensionalized
NdArray

Examples

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