Struct osqp::Settings
[−]
[src]
pub struct Settings { /* fields omitted */ }The settings used when initialising a solver.
Methods
impl Settings[src]
fn rho(self, value: f64) -> Settings[src]
Sets the ADMM step rho.
fn sigma(self, value: f64) -> Settings[src]
Sets the ADMM step sigma.
fn scaling(self, value: Option<u32>) -> Settings[src]
Sets the number of heuristic data scaling iterations.
If None scaling is disabled.
Panics on 32-bit platforms if the value is above i32::max_value().
fn adaptive_rho(self, value: bool) -> Settings[src]
Enables choosing rho adaptively.
fn adaptive_rho_interval(self, value: Option<u32>) -> Settings[src]
Sets the number of iterations between rho adaptations.
If None it is automatic.
Panics on 32-bit platforms if the value is above i32::max_value().
fn adaptive_rho_tolerance(self, value: f64) -> Settings[src]
Sets the tolerance for adapting rho.
The new rho has to be x times larger or 1/x times smaller than the current rho to trigger
a new factorization.
fn adaptive_rho_fraction(self, value: f64) -> Settings[src]
Set the interval for adapting rho as a fraction of the setup time.
fn max_iter(self, value: u32) -> Settings[src]
Sets the maximum number of ADMM iterations.
Panics on 32-bit platforms if the value is above i32::max_value().
fn eps_abs(self, value: f64) -> Settings[src]
Sets the absolute convergence tolerance.
fn eps_rel(self, value: f64) -> Settings[src]
Sets the relative convergence tolerance.
fn eps_prim_inf(self, value: f64) -> Settings[src]
Sets the primal infeasibility tolerance.
fn eps_dual_inf(self, value: f64) -> Settings[src]
Sets the dual infeasibility tolerance.
fn alpha(self, value: f64) -> Settings[src]
Sets the linear solver relaxation parameter.
fn linsys_solver(self, value: LinsysSolver) -> Settings[src]
Sets the linear system solver to use.
fn delta(self, value: f64) -> Settings[src]
Sets the polishing regularization parameter.
fn polish(self, value: bool) -> Settings[src]
Enables polishing the ADMM solution.
fn polish_refine_iter(self, value: u32) -> Settings[src]
Sets the number of iterative refinement steps to use when polishing.
Panics on 32-bit platforms if the value is above i32::max_value().
fn verbose(self, value: bool) -> Settings[src]
Enables writing progress to stdout.
fn scaled_termination(self, value: bool) -> Settings[src]
Enables scaled termination criteria.
fn check_termination(self, value: Option<u32>) -> Settings[src]
Sets the number of ADMM iterations between termination checks.
If None termination checking is disabled.
Panics on 32-bit platforms if the value is above i32::max_value().
fn warm_start(self, value: bool) -> Settings[src]
Enables warm starting the primal and dual variables from the previous solution.
Trait Implementations
impl Clone for Settings[src]
fn clone(&self) -> Settings[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0[src]
Performs copy-assignment from source. Read more