iode.Scalar

class iode.Scalar

IODE Scalars are dimensionless variables defined by a single value. They can be the estimated coefficients in an equation or constant values over time (relax = 0).

Parameters:

value: float

value of the scalar. Defaults to 0.9.

relax: float

relax value of the scalar. The value must be between 0.0 and 1.0. Defaults to 1.0

Examples

>>> from iode import Scalar
>>> # default relax
>>> scalar = Scalar(0.9)
>>> scalar
Scalar(0.9, 1, na)
>>> # specific value and relax
>>> scalar = Scalar(0.9, 0.8)
>>> scalar
Scalar(0.9, 0.8, na)

Attributes:

value: float

Value of the scalar.

relax: float

Relaxation parameter used in the context of equations estimation. For example, setting the relaxation parameter to 0 will ‘lock’ the coefficient during the estimation process.

std: float

Standard deviation. Calculated during the estimation process.

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)

Attributes

relax	relax: float
std	std: float
value	value: float