Skip to content

Options

struct Options

Solver options

Variables

Name Description
convergence_kkt_norm KKT Inf norm must be less than this value for convergence
convergence_eq_violation Equality constraint violation Inf norm must be less than this value for convergence
convergence_ineq_violation Inequality constraint violation Inf norm must be less than this value for convergence
convergence_comp_violation Complementarity constraint violation Inf norm must be less than this value for convergence
outer_step_kkt_norm KKT Inf norm must be less than this value to take an outer step in the algorithm
penalty_initial Initial AL penalty parameter
penalty_max Maximum AL penalty parameter
penalty_scaling AL penalty parameter scaling factor, multiplies current penalty parameter
relaxation_initial Initial relaxation parameter for complementarity and inequality constraints
relaxation_min Minimum relaxation parameter for complementarity and inequality constraints
relaxation_scaling Relaxation parameter scaling factor, multiplies current relaxation parameter
max_iters Maximum number of iterations for the solver, iterations refers to outer + inner iterations
max_iters_linesearch Maximum number of iterations for the filter linesearch
gamma_objective (filter) Sufficient progress parameter for objective value decrease
gamma_constraint (filter) Sufficient progress parameter for constraint violation decrease
ruiz_iterations Number of ruiz iterations for scaling
output_dir Output directory for solution and solve information
verbosity Verbosity level: 0=silent, 1=per-iteration table + footer
print_every Print a row every N iterations (only used when verbosity >= 1)
debug Write a JSONL debug log with iterates and solver state (one JSON object per line)
debug_output_path Path to the debug log file (used when debug=true)
debug_log_every Log every N iterations (1 = every iteration)

Variable Details

convergence_comp_violation

double convergence_comp_violation

Complementarity constraint violation Inf norm must be less than this value for convergence

convergence_eq_violation

double convergence_eq_violation

Equality constraint violation Inf norm must be less than this value for convergence

convergence_ineq_violation

double convergence_ineq_violation

Inequality constraint violation Inf norm must be less than this value for convergence

convergence_kkt_norm

double convergence_kkt_norm

KKT Inf norm must be less than this value for convergence

debug

bool debug

Write a JSONL debug log with iterates and solver state (one JSON object per line)

debug_log_every

int debug_log_every

Log every N iterations (1 = every iteration)

debug_output_path

std::string debug_output_path

Path to the debug log file (used when debug=true)

gamma_constraint

double gamma_constraint

(filter) Sufficient progress parameter for constraint violation decrease

gamma_objective

double gamma_objective

(filter) Sufficient progress parameter for objective value decrease

max_iters

int max_iters

Maximum number of iterations for the solver, iterations refers to outer + inner iterations

max_iters_linesearch

int max_iters_linesearch

Maximum number of iterations for the filter linesearch

outer_step_kkt_norm

double outer_step_kkt_norm

KKT Inf norm must be less than this value to take an outer step in the algorithm

output_dir

std::filesystem::path output_dir

Output directory for solution and solve information

penalty_initial

double penalty_initial

Initial AL penalty parameter

penalty_max

double penalty_max

Maximum AL penalty parameter

penalty_scaling

double penalty_scaling

AL penalty parameter scaling factor, multiplies current penalty parameter

int print_every

Print a row every N iterations (only used when verbosity >= 1)

relaxation_initial

double relaxation_initial

Initial relaxation parameter for complementarity and inequality constraints

relaxation_min

double relaxation_min

Minimum relaxation parameter for complementarity and inequality constraints

relaxation_scaling

double relaxation_scaling

Relaxation parameter scaling factor, multiplies current relaxation parameter

ruiz_iterations

int ruiz_iterations

Number of ruiz iterations for scaling

verbosity

int verbosity

Verbosity level: 0=silent, 1=per-iteration table + footer