CADETProcess.dataStructure.parameter

Classes

Bool(*args[, ty])	Parameter descriptor constrained to boolean values.
Callable(*args[, default, is_optional, ...])	Parameter descriptor constrained to callable objects.
Constant(value, *args, **kwargs)	Parameter that is immutable once set.
DependentlyModulated(*args, size, **kwargs)	Mixin for checking parameter shapes based on other instance attributes.
DependentlyModulatedUnsignedList(*args[, ty])	List of unsigned values whose size is dependent on other attributes.
Dictionary(*args[, ty])	Parameter descriptor constrained to dictionary (dict) values.
DimensionalizedArray([n_dim])	Parameter descriptor constrained to np.arrays with a specific dimensionality.
Float(*args[, ty])	Parameter descriptor constrained to float values.
Integer(*args[, ty])	Parameter descriptor constrained to integer values.
List(*args[, ty])	Parameter descriptor constrained to list values.
Matrix([n_dim])	Parameter descriptor for two-dimensional numpy arrays (matrices).
NdArray(*args[, ty])	Parameter descriptor constrained to np.ndarray values.
NdPolynomial(*args[, n_entries, n_coeff])	Dependently sized polynomial for n entries.
ParameterBase(*args[, default, is_optional, ...])	Base class for model parameters with potential constraints or type-casting.
Polynomial(*args, **kwargs)	Represent a single polynomial using coefficients.
Ranged(*args[, lb, lb_op, ub, ub_op])	Descriptor for parameters within specified bounds.
RangedArray(*args[, lb, lb_op, ub, ub_op])	Parameter descriptor for arrays with elements constrained within some bounds.
RangedFloat(*args[, ty])	Parameter descriptor for float parameters constrained within bounds.
RangedInteger(*args[, ty])	Parameter descriptor for integers parameters constrained within bounds.
RangedList(*args[, ty])	Parameter descriptor for lists with elements constrained within bounds.
RangedNdArray(*args[, ty])	Parameter descriptor for numpy arrays with elements constrained within bounds.
Sized(*args, size, **kwargs)	Descriptor for parameters with size that potentially depends on instance attributes.
SizedList(*args[, ty])	Descriptor for lists whose size may depend on other instance attributes.
SizedNdArray(*args[, ty])	Descriptor for NumPy arrays whose size may depend on other instance attributes.
SizedRangedIntegerList(*args[, ty])	Descriptor for ranged lists of integers whose size depends on other instance attributes.
SizedRangedList(*args[, ty])	Descriptor for ranged lists whose size depends on other instance attributes.
SizedTuple(*args[, ty])	Descriptor for tuples whose size may depend on other instance attributes.
SizedUnsignedIntegerList(*args[, ty])	Descriptor for unsigned lists of integers whose size depends on other instance attributes.
SizedUnsignedList(*args[, ty])	Descriptor for unsigned lists whose size depends on other instance attributes.
SizedUnsignedNdArray(*args[, ty])	Descriptor for unsigned numpy arrays whose size depends on other instance attributes.
String(*args[, ty])	Parameter descriptor constrained to string values.
Switch(*args, valid, **kwargs)	Parameter that can be set to one of several predefined options.
Tuple(*args[, ty])	Parameter descriptor constrained to tuple values.
Typed(*args[, ty])	Mixin for parameters constrained to a specific type.
Unsigned(*args, **kwargs)	Parameter descriptor for non-negative parameters.
UnsignedArray(*args, **kwargs)	Parameter descriptor for arrays with non-negative elements.
UnsignedFloat(*args[, ty])	Parameter descriptor for unsigned floating-point parameters.
UnsignedInteger(*args[, ty])	Parameter descriptor for unsigned integer parameters.
UnsignedList(*args[, ty])	Parameter descriptor for lists with non-negative elements.
UnsignedNdArray(*args[, ty])	Parameter descriptor for numpy arrays with non-negative elements.
Vector([n_dim])	Parameter descriptor for one-dimensional numpy arrays (vectors).