testers module

Regroup the functions dedicated to testing data.

They are used by SimulationOutputEvaluator. They all take a value and limits/upper or lower or objective value as arguments, and return a boolean.

value_is_within_limits(treated_value, limits, **kwargs)

Test if the given value is within the given limits.

Parameters:

• treated_value (ndarray | float)

• limits (tuple[ndarray | float, ndarray | float])

• kwargs (bool)

Return type:

bool

value_is_above(treated_value, lower_limit, **kwargs)

Test if the given value is above a threshold.

Parameters:

• treated_value (ndarray | float)

• lower_limit (ndarray | float)

• kwargs (bool)

Return type:

bool

value_is_below(treated_value, upper_limit, **kwargs)

Test if the given value is below a threshold.

Parameters:

• treated_value (ndarray | float)

• upper_limit (ndarray | float)

• kwargs (bool)

Return type:

bool

value_is(treated_value, objective_value, tol=1e-10, **kwargs)

Test if the value equals objective_value.

Parameters:

• treated_value (ndarray | float)

• objective_value (ndarray | float)

• tol (float, default: 1e-10)

• kwargs (bool)

Return type:

bool