Variable

class Variable(initial_value, upper_bound=inf, lower_bound=-inf, name=None)

A parameter, or list of parameters, whose values the calibration will determine.

Parameters

  • initial_value (np.ndarray) – The initial value assigned to the variable. It must only contain real values, and the values must lie between upper_bound and lower_bound, if they are defined. It cannot have more than one dimension.
  • upper_bound (float , optional) – The upper limit of the values of this variable. Defaults to np.inf, in which case no upper limit is enforced.
  • lower_bound (float , optional) – The upper limit of the values of this variable. Defaults to -np.inf, in which case no lower limit is enforced.
  • name (str or None , optional) – The name of the variable. Defaults to None.

Methods

getReturn the value of the variable.
setUpdate the value of the variable.
to_optimization_variableCreate an optimization variable that matches the form of the calibration variable.

Was this useful?