Skip to main content

Module options

Module options 

Source
Expand description

Solver configuration parameters.

SolverOptions controls simplex and IPM solver behaviour: tolerances, iteration limits, refactorisation frequency, and algorithm selection.

§Solver-specific options

IPM-specific parameters live in IpmOptions, accessed via SolverOptions::ipm.

Structs§

GlobalOptimizationConfig
Spatial Branch-and-Bound config for global QP optimisation.
IpmOptions
IPM (interior-point method) solver options.
LpWarmStart
Extended LP warm-start.
MipConfig
MILP/MIQP branch-and-bound config.
MultiStartConfig
Multi-start local search user-facing config.
OptionsError
Error returned when option values fail validation.
QpWarmStart
QP IP-PMM interior-point warm-start data.
SolverOptions
Solver configuration.
WarmStartBasis
Basis information for warm-starting simplex.

Enums§

BranchingStrategy
Branching strategy for spatial B&B.
DualPricing
Dual simplex leaving (depart) strategy.
MipBranching
MILP/MIQP branching variable selection strategy.
SimplexMethod
Simplex algorithm selection.
StartStrategy
Multi-start sampling strategy.
Tolerance
Convergence accuracy level. Abstracts ipm.eps; the solver derives its internal threshold from this enum and ignores ipm.eps.

Constants§

DEFAULT_CLAMP_TOL
Default clamp threshold for micro-values in solver output.
DEFAULT_GLOBAL_GAP_TOL
Defaults for GlobalOptimizationConfig.
DEFAULT_GLOBAL_MAX_DEPTH
DEFAULT_GLOBAL_MAX_NODES
DEFAULT_INTEGER_FEAS_TOL
DEFAULT_IPM_DELTA_INIT
Default initial proximity regularisation for IpmOptions::delta_p_init and IpmOptions::delta_d_init.
DEFAULT_IPM_DELTA_MIN
Default proximity regularisation lower bound for IpmOptions::delta_min.
DEFAULT_IPM_EPS
Default convergence tolerance for IpmOptions::eps.
DEFAULT_IPM_MAX_CORRECTORS
Default Gondzio corrector count (Gondzio 1997, recommended range 2–5).
DEFAULT_MIP_GAP_TOL
Defaults for MipConfig.
DEFAULT_MIP_MAX_DEPTH
DEFAULT_MIP_MAX_NODES
DEFAULT_MULTISTART_SEED
Default seed for MultiStartConfig. Fixed non-zero value for deterministic test environments.
TOLERANCE_FAST_EPS
IPM eps for Tolerance::Fast: 100× looser than Medium for faster convergence.
TOLERANCE_HIGH_EPS
IPM eps for Tolerance::High.
TOLERANCE_MEDIUM_EPS
IPM eps for Tolerance::Medium (default).

Functions§

default_max_etas
Auto-compute max_etas from problem size.