bluemira.optimisation._algorithm

Enumeration of supported optimiser algorithms.

Note that it may not be the case that all backends support all algorithms. Each Optimiser implementation must state which of these algorithms it supports.

Attributes

AlgorithmType

Classes

Algorithm

Enumeration of available optimisation algorithms.

AlgorithmConditions

Algorithm conditions container

AlgorithmDefaultConditions

Default Algorithm conditions

Module Contents

class bluemira.optimisation._algorithm.Algorithm(*args, **kwds)

Bases: enum.Enum

Inheritance diagram of bluemira.optimisation._algorithm.Algorithm

Enumeration of available optimisation algorithms.

SLSQP
COBYLA
SBPLX
MMA
BFGS
DIRECT
DIRECT_L
CRS
ISRES
NELDER_MEAD
POWELL
L_BFGS_B
TNC
COBYLA_SCIPY
COBYQA
SLSQP_SCIPY
TRUST_CONSTR
classmethod _missing_(value: str) Algorithm

Handle cases where the algorithm type provided is not a valid algorithm.

Parameters:

value (str) – The string representation of the algorithm type.

Returns:

The corresponding algorithm.

Raises:

ValueError – If the algorithm type is not a valid algorithm.

Return type:

Algorithm

bluemira.optimisation._algorithm.AlgorithmType
class bluemira.optimisation._algorithm.AlgorithmConditions

Algorithm conditions container

ftol_abs: float | None = None
ftol_rel: float | None = None
xtol_abs: float | None = None
xtol_rel: float | None = None
max_eval: int = 2000
max_time: float | None = None
stop_val: float | None = None
to_dict() dict[str, float]
Returns:

Converted dictionary without Nones

Return type:

dict[str, float]

class bluemira.optimisation._algorithm.AlgorithmDefaultConditions

Default Algorithm conditions

SLSQP: AlgorithmConditions
COBYLA: AlgorithmConditions
SBPLX: AlgorithmConditions
MMA: AlgorithmConditions
BFGS: AlgorithmConditions
DIRECT: AlgorithmConditions
DIRECT_L: AlgorithmConditions
CRS: AlgorithmConditions
ISRES: AlgorithmConditions