CADETProcess.dataStructure.parameter.DependentlyModulated

class CADETProcess.dataStructure.parameter.DependentlyModulated(*args: Any, size: int | tuple, **kwargs: Any)

Mixin for checking parameter shapes based on other instance attributes.

This mixin ensures that the size of a parameter is modulo an expected size. If this condition is not met, a ValueError is raised.

Attributes:

default

Any: Get or set the default value of the parameter.

is_independent

Determine whether the size is independent of other parameters.

Methods

check_mod_value(instance, value)	Check if the size of the parameter modulo its expected size is zero.
check_size(instance, value)	Check if the size of the parameter modulo its expected size is zero.
get_default_value(instance)	Return default values if necessary.
get_expected_size(instance)	Compute the expected size based on the instance's other attributes.
get_size(value)	Determine the size of the provided value.