gemseo.algos.opt.nlopt.settings.nlopt_slsqp_settings module#

Settings for the NLopt SLSQP algorithm.

Settings NLOPT_SLSQP_Settings(*, kkt_tol_abs=inf, kkt_tol_rel=inf, enable_progress_bar=None, eq_tolerance=0.01, ineq_tolerance=0.0001, log_problem=True, max_time=0.0, normalize_design_space=True, progress_bar_data_name='ProgressBarData', reset_iteration_counters=True, round_ints=True, store_jacobian=True, use_database=True, use_one_line_progress_bar=False, ftol_rel=1e-08, ftol_abs=1e-14, max_iter=1000, scaling_threshold=None, stop_crit_n_x=None, xtol_rel=1e-08, xtol_abs=1e-14, stopval=-inf)[source]#

Bases: BaseNLoptSettings, BaseGradientBasedAlgorithmSettings

The settings for the NLopt SLSQP algorithm.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

  • kkt_tol_abs (Annotated[float, Ge(ge=0)]) --

    By default it is set to inf.

  • kkt_tol_rel (Annotated[float, Ge(ge=0)]) --

    By default it is set to inf.

  • enable_progress_bar (bool | None)

  • eq_tolerance (Annotated[float, Ge(ge=0)]) --

    By default it is set to 0.01.

  • ineq_tolerance (Annotated[float, Ge(ge=0)]) --

    By default it is set to 0.0001.

  • log_problem (bool) --

    By default it is set to True.

  • max_time (Annotated[float, Ge(ge=0)]) --

    By default it is set to 0.0.

  • normalize_design_space (bool) --

    By default it is set to True.

  • progress_bar_data_name (ProgressBarDataName) --

    By default it is set to "ProgressBarData".

  • reset_iteration_counters (bool) --

    By default it is set to True.

  • round_ints (bool) --

    By default it is set to True.

  • store_jacobian (bool) --

    By default it is set to True.

  • use_database (bool) --

    By default it is set to True.

  • use_one_line_progress_bar (bool) --

    By default it is set to False.

  • ftol_rel (Annotated[float, Ge(ge=0), Ge(ge=0)]) --

    By default it is set to 1e-08.

  • ftol_abs (Annotated[float, Ge(ge=0), Ge(ge=0)]) --

    By default it is set to 1e-14.

  • max_iter (Annotated[int, Gt(gt=0)]) --

    By default it is set to 1000.

  • scaling_threshold (Annotated[float, Ge(ge=0)] | None)

  • stop_crit_n_x (Annotated[int | None, Ge(ge=2)])

  • xtol_rel (Annotated[float, Ge(ge=0), Ge(ge=0)]) --

    By default it is set to 1e-08.

  • xtol_abs (Annotated[float, Ge(ge=0), Ge(ge=0)]) --

    By default it is set to 1e-14.

  • stopval (float) --

    By default it is set to -inf.

Return type:

None

model_post_init(context, /)#

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that's what pydantic-core passes when calling it.

Parameters:

  • self (BaseModel) -- The BaseModel instance.

  • context (Any) -- The context.

Return type:

None