Skip to content

Commit c3c0390

Browse files
arnavk23arnavk23
committed
docs: documenting options
1 parent 0cc4e74 commit c3c0390

File tree

2 files changed

+135
-0
lines changed

2 files changed

+135
-0
lines changed

‎docs/index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,6 @@
11
Welcome to Uno's documentation
22
==============================
3+
4+
See the available configuration options on the `Options` page:
5+
6+
- Options: `options.md`

‎docs/options.md‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# Options
2+
3+
This document lists the configuration options that Uno accepts, their types and default values. Options are grouped by functional area. Defaults are taken from `uno/options/DefaultOptions.cpp`.
4+
5+
## Termination
6+
- `primal_tolerance` (double) — 1e-8
7+
- `dual_tolerance` (double) — 1e-8
8+
- `loose_primal_tolerance` (double) — 1e-6
9+
- `loose_dual_tolerance` (double) — 1e-6
10+
- `loose_tolerance_consecutive_iteration_threshold` (integer) — 15
11+
- `max_iterations` (integer) — 2000
12+
- `time_limit` (double) — infinity
13+
- `print_solution` (bool) — false
14+
- `unbounded_objective_threshold` (double) — -1e20
15+
- `enforce_linear_constraints` (bool) — false
16+
17+
## Statistics table ordering
18+
- `statistics_major_column_order` (integer) — 1
19+
- `statistics_minor_column_order` (integer) — 2
20+
- `statistics_penalty_parameter_column_order` (integer) — 5
21+
- `statistics_barrier_parameter_column_order` (integer) — 8
22+
- `statistics_SOC_column_order` (integer) — 9
23+
- `statistics_TR_radius_column_order` (integer) — 10
24+
- `statistics_LS_step_length_column_order` (integer) — 10
25+
- `statistics_restoration_phase_column_order` (integer) — 20
26+
- `statistics_primal_regularization_column_order` (integer) — 21
27+
- `statistics_funnel_width_column_order` (integer) — 25
28+
- `statistics_step_norm_column_order` (integer) — 31
29+
- `statistics_objective_column_order` (integer) — 100
30+
- `statistics_primal_feasibility_column_order` (integer) — 101
31+
- `statistics_dual_feasibility_column_order` (integer) — 102
32+
- `statistics_stationarity_column_order` (integer) — 104
33+
- `statistics_complementarity_column_order` (integer) — 105
34+
- `statistics_status_column_order` (integer) — 200
35+
36+
## Main options
37+
- `logger` (string) — "INFO" (levels: SILENT|DISCRETE|WARNING|INFO|DEBUG|DEBUG2|DEBUG3)
38+
- `hessian_model` (string) — "exact" (alternatives: "zero")
39+
- `inertia_correction_strategy` (string) — "primal"
40+
- `scale_functions` (bool) — false
41+
- `function_scaling_threshold` (double) — 100.0
42+
- `function_scaling_factor` (double) — 100.0
43+
- `scale_residuals` (bool) — true
44+
- `progress_norm` (string) — "L1" (L1|L2|INF)
45+
- `residual_norm` (string) — "INF" (L1|L2|INF)
46+
- `residual_scaling_threshold` (double) — 100.0
47+
- `protect_actual_reduction_against_roundoff` (bool) — false
48+
- `print_subproblem` (bool) — false
49+
50+
## Globalization strategy options
51+
- `armijo_decrease_fraction` (double) — 1e-4
52+
- `armijo_tolerance` (double) — 1e-9
53+
54+
## Switching method options
55+
- `switching_delta` (double) — 0.999
56+
- `switching_infeasibility_exponent` (double) — 2
57+
58+
## Filter method options
59+
- `filter_type` (string) — "standard" (standard|nonmonotone)
60+
- `filter_beta` (double) — 0.999
61+
- `filter_gamma` (double) — 0.001
62+
- `filter_ubd` (double) — 1e2
63+
- `filter_fact` (double) — 1.25
64+
- `filter_capacity` (integer) — 50
65+
- `filter_sufficient_infeasibility_decrease_factor` (double) — 0.9
66+
- `nonmonotone_filter_number_dominated_entries` (integer) — 3
67+
68+
## Funnel options
69+
- `funnel_kappa` (double) — 0.5
70+
- `funnel_beta` (double) — 0.9999
71+
- `funnel_gamma` (double) — 0.001
72+
- `funnel_ubd` (double) — 1.0
73+
- `funnel_fact` (double) — 1.5
74+
- `funnel_update_strategy` (integer) — 1
75+
- `funnel_require_acceptance_wrt_current_iterate` (bool) — false
76+
77+
## Line search options
78+
- `LS_backtracking_ratio` (double) — 0.5
79+
- `LS_min_step_length` (double) — 1e-12
80+
- `LS_scale_duals_with_step_length` (bool) — true
81+
82+
## Regularization options
83+
- `regularization_failure_threshold` (double) — 1e40
84+
- `regularization_initial_value` (double) — 1e-4
85+
- `regularization_increase_factor` (double) — 2
86+
- `primal_regularization_initial_factor` (double) — 1e-4
87+
- `dual_regularization_fraction` (double) — 1e-8
88+
- `primal_regularization_lb` (double) — 1e-20
89+
- `primal_regularization_decrease_factor` (double) — 3.0
90+
- `primal_regularization_fast_increase_factor` (double) — 100.0
91+
- `primal_regularization_slow_increase_factor` (double) — 8.0
92+
- `threshold_unsuccessful_attempts` (integer) — 8
93+
94+
## Trust region options
95+
- `TR_radius` (double) — 10.0
96+
- `TR_increase_factor` (double) — 2
97+
- `TR_decrease_factor` (double) — 2
98+
- `TR_aggressive_decrease_factor` (double) — 4
99+
- `TR_activity_tolerance` (double) — 1e-6
100+
- `TR_min_radius` (double) — 1e-7
101+
- `TR_radius_reset_threshold` (double) — 1e-4
102+
103+
## Feasibility restoration options
104+
- `switch_to_optimality_requires_linearized_feasibility` (bool) — true
105+
- `l1_constraint_violation_coefficient` (double) — 1
106+
107+
## Barrier subproblem options
108+
- `barrier_function` (string) — "log"
109+
- `barrier_initial_parameter` (double) — 0.1
110+
- `barrier_default_multiplier` (double) — 1
111+
- `barrier_tau_min` (double) — 0.99
112+
- `barrier_k_sigma` (double) — 1e10
113+
- `barrier_smax` (double) — 100
114+
- `barrier_k_mu` (double) — 0.2
115+
- `barrier_theta_mu` (double) — 1.5
116+
- `barrier_k_epsilon` (double) — 10
117+
- `barrier_update_fraction` (double) — 10
118+
- `barrier_regularization_exponent` (double) — 0.25
119+
- `barrier_small_direction_factor` (double) — 10.0
120+
- `barrier_push_variable_to_interior_k1` (double) — 1e-2
121+
- `barrier_push_variable_to_interior_k2` (double) — 1e-2
122+
- `barrier_damping_factor` (double) — 1e-5
123+
- `least_square_multiplier_max_norm` (double) — 1e3
124+
125+
## Solver selection
126+
- `QP_solver` (string) — chosen automatically from available QP solvers if any
127+
- `LP_solver` (string) — chosen automatically from available LP solvers if any
128+
- `linear_solver` (string) — chosen automatically from available linear solvers if any
129+
130+
## BQPD options
131+
- `BQPD_kmax_heuristic` (string) — "filtersqp"

0 commit comments

Comments
 (0)