scipy

LBFGSBOptimizer

Bases: ScipyOptimizer

method class-attribute instance-attribute

method = 'L-BFGS-B'

LBFGSBOptimizerOptions

Bases: ScipyOptimizerOptions

eps instance-attribute

eps: NotRequired[float]

finite_diff_rel_step instance-attribute

finite_diff_rel_step: NotRequired[ndarray]

ftol instance-attribute

ftol: NotRequired[float]

gtol instance-attribute

gtol: NotRequired[float]

iprint instance-attribute

iprint: NotRequired[int]

maxcor instance-attribute

maxcor: NotRequired[int]

maxls instance-attribute

maxls: NotRequired[int]

NelderMeadOptimizer

Bases: ScipyOptimizer

method class-attribute instance-attribute

method = 'Nelder-Mead'

NelderMeadOptimizerOptions

Bases: ScipyOptimizerOptions

adaptive instance-attribute

adaptive: NotRequired[bool]

fatol instance-attribute

fatol: NotRequired[float]

initial_simplex instance-attribute

initial_simplex: NotRequired[ndarray]

maxfev instance-attribute

maxfev: NotRequired[int]

return_all instance-attribute

return_all: NotRequired[bool]

xatol instance-attribute

xatol: NotRequired[float]

PowellOptimizer

Bases: ScipyOptimizer

method class-attribute instance-attribute

method = 'Powell'

PowellOptimizerOptions

Bases: ScipyOptimizerOptions

direc instance-attribute

direc: NotRequired[ndarray]

maxfev instance-attribute

maxfev: NotRequired[int]

tol instance-attribute

tol: NotRequired[float]

ScipyOptimizer

Bases: OptimizerBase, ABC

method instance-attribute

method: str

optimize

optimize() -> ScipyOptimizerResult

setup

setup()

ScipyOptimizerOptions

Bases: OptimizerOptions

disp instance-attribute

disp: NotRequired[bool]

ScipyOptimizerResult

Bases: OptimizerResult

Represents the optimization result for scipy optimize algorithms

Notes

``OptimizeResult`` may have additional attributes not listed here depending
on the specific solver being used. Since this class is essentially a
subclass of dict with attribute accessors, one can see which
attributes are available using the `OptimizeResult.keys` method.

hess class-attribute instance-attribute

hess: List[List[float]] = []

Values of Hessian, The Hessians may be approximations, see the documentation of the function in question.

jac class-attribute instance-attribute

jac: List[float] = []

Values of Jacobin

maxcv class-attribute instance-attribute

maxcv: float = 0.0

The maximum constraint violation.

message class-attribute instance-attribute

message: str = ''

Description of the cause of the termination.

nhev class-attribute instance-attribute

nhev: int = 0

Number of evaluations of the hessian

njev class-attribute instance-attribute

njev: int = 0

Number of evaluations of the jacobin

status class-attribute instance-attribute

status: int = -1

Termination status of the optimizer. Its value depends on the underlying solver. Refer to message for details.

success class-attribute instance-attribute

success: bool = False

Whether the optimizer exited successfully.

TNCOptimizer

Bases: ScipyOptimizer

method class-attribute instance-attribute

method = 'TNC'

TNCOptimizerOptions

Bases: ScipyOptimizerOptions

accuracy instance-attribute

accuracy: NotRequired[float]

eps instance-attribute

eps: NotRequired[float]

eta instance-attribute

eta: NotRequired[float]

finite_diff_rel_step instance-attribute

finite_diff_rel_step: NotRequired[ndarray]

ftol instance-attribute

ftol: NotRequired[float]

gtol instance-attribute

gtol: NotRequired[float]

maxCGit instance-attribute

maxCGit: NotRequired[int]

minfev instance-attribute

minfev: NotRequired[float]

offset instance-attribute

offset: NotRequired[float]

rescale instance-attribute

rescale: NotRequired[float]

scale instance-attribute

scale: NotRequired[List[float]]

stepmx instance-attribute

stepmx: NotRequired[float]

xtol instance-attribute

xtol: NotRequired[float]