bluemira.optimisation._nlopt.conditions

Classes

NLOptConditions

Hold and validate optimiser stopping conditions.

Module Contents

class bluemira.optimisation._nlopt.conditions.NLOptConditions

Hold and validate optimiser stopping conditions.

ftol_abs: float | None = None

ftol_rel: float | None = None

xtol_abs: float | None = None

xtol_rel: float | None = None

max_eval: int | None = None

max_time: float | None = None

stop_val: float | None = None

__post_init__()

Validate initialised values.

to_dict() → dict[str, float]

Returns:

The data in dictionary form.

Return type:

dict[str, float]

_validate() → None

Return type:

None

_no_stopping_condition_set() → bool

Checks if all stopping conditions are unset.

Returns:

True if all stopping conditions are None, otherwise False.

Return type:

bool