kappa_sdk.kw.ImproveVariable#

class kappa_sdk.kw.ImproveVariable(model_parameter, current_value, use_log_space, minimum_bound, maximum_bound)[source]#

ImproveVariable object. Describes an improve variable with mim/max, actual value and transformation applied

Attributes

ImproveVariable.current_value_transformed

ImproveVariable.maximum_bound_transformed

ImproveVariable.minimum_bound_transformed

Methods

ImproveVariable.apply_inverse_transformation_if_required(value)

Apply inverse transformation to a value if we use a log space :param value: Value to apply the inverse transformation if we use a log space
Parameters:

  • model_parameter (ModelParameter)

  • current_value (float)

  • use_log_space (bool)

  • minimum_bound (float)

  • maximum_bound (float)

__init__(model_parameter, current_value, use_log_space, minimum_bound, maximum_bound)[source]#
Parameters:

  • model_parameter (ModelParameter)

  • current_value (float)

  • use_log_space (bool)

  • minimum_bound (float)

  • maximum_bound (float)

apply_inverse_transformation_if_required(value)[source]#

Apply inverse transformation to a value if we use a log space :param value: Value to apply the inverse transformation if we use a log space

Returns:

float – Value transformed

Parameters:

value (float)

Return type:

float

property current_value_transformed: float#
Returns:

float – Current value transformed

property minimum_bound_transformed: float#
Returns:

float – Minimum value transformed

property maximum_bound_transformed: float#
Returns:

float – Maximum value transformed