bluemira.optimisation._scipy.parameters

Classes

NelderMeadParams

Options for Nelder-Mead.

PowellParams

Options for Powell.

LBFGSBParams

Options for L-BFGS-B.

TNCParams

Options for TNC.

COBYLAParams

Options for COBYLA.

COBYQAParams

Options for COBYQA.

SLSQPParams

Options for SLSQP.

TrustConstrParams

Options for Trust-Constr.

Functions

_make_alg_params(→ collections.abc.Mapping[str, ...)

Algorithm parameter factory.

Module Contents

class bluemira.optimisation._scipy.parameters.NelderMeadParams

Options for Nelder-Mead.

maxiter: int | None = None
disp: bool | None = None
maxfev: int | None = None
return_all: bool | None = None
initial_simplex: Any | None = None
xatol: float | None = None
fatol: float | None = None
adaptive: bool | None = None
class bluemira.optimisation._scipy.parameters.PowellParams

Options for Powell.

maxiter: int | None = None
disp: bool | None = None
xtol: float | None = None
ftol: float | None = None
maxfev: int | None = None
direc: Any | None = None
return_all: bool | None = None
class bluemira.optimisation._scipy.parameters.LBFGSBParams

Options for L-BFGS-B.

maxiter: int | None = None
disp: int | None = None
maxcor: int | None = None
ftol: float | None = None
gtol: float | None = None
eps: float | Any | None = None
maxfun: int | None = None
iprint: int | None = None
maxls: int | None = None
finite_diff_rel_step: Any | None = None
workers: int | Any | None = None
class bluemira.optimisation._scipy.parameters.TNCParams

Options for TNC.

maxiter: int | None = None
eps: float | Any | None = None
scale: list[float] | None = None
offset: float | None = None
disp: bool | None = None
maxCGit: int | None = None
eta: float | None = None
stepmx: float | None = None
accuracy: float | None = None
minfev: float | None = None
ftol: float | None = None
xtol: float | None = None
gtol: float | None = None
rescale: float | None = None
finite_diff_rel_step: Any | None = None
maxfun: int | None = None
workers: int | Any | None = None
class bluemira.optimisation._scipy.parameters.COBYLAParams

Options for COBYLA.

maxiter: int | None = None
rhobeg: float | None = None
tol: float | None = None
disp: int | None = None
catol: float | None = None
f_target: float | None = None
class bluemira.optimisation._scipy.parameters.COBYQAParams

Options for COBYQA.

maxiter: int | None = None
disp: bool | None = None
maxfev: int | None = None
f_target: float | None = None
feasibility_tol: float | None = None
initial_tr_radius: float | None = None
final_tr_radius: float | None = None
scale: bool | None = None
class bluemira.optimisation._scipy.parameters.SLSQPParams

Options for SLSQP.

maxiter: int | None = None
ftol: float | None = None
eps: float | None = None
disp: bool | None = None
finite_diff_rel_step: Any | None = None
workers: int | Any | None = None
class bluemira.optimisation._scipy.parameters.TrustConstrParams

Options for Trust-Constr.

maxiter: int | None = None
gtol: float | None = None
xtol: float | None = None
barrier_tol: float | None = None
sparse_jacobian: bool | None = None
initial_tr_radius: float | None = None
initial_constr_penalty: float | None = None
initial_barrier_parameter: float | None = None
initial_barrier_tolerance: float | None = None
factorization_method: str | None = None
finite_diff_rel_step: Any | None = None
verbose: int | None = None
disp: bool | None = None
workers: int | Any | None = None
bluemira.optimisation._scipy.parameters._make_alg_params(user_params: collections.abc.Mapping[str, int | float], param_cls: type, overrides: dict[str, str]) collections.abc.Mapping[str, int | float]

Algorithm parameter factory.

Returns:

  • The dataclass associated with the given algorithm,

  • with user parameters merged into the default parameters.

Parameters:
  • user_params (collections.abc.Mapping[str, int | float])

  • param_cls (type)

  • overrides (dict[str, str])

Return type:

collections.abc.Mapping[str, int | float]