CADETProcess.dataStructure.parameter.Vector

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

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

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

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	alias of ndarray