[−][src]Struct osqp::Settings
The settings used when initialising a solver.
Implementations
impl Settings
[src]
pub fn rho(self, value: f64) -> Settings
[src]
Sets the ADMM step rho.
pub fn sigma(self, value: f64) -> Settings
[src]
Sets the ADMM step sigma.
pub 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()
.
pub fn adaptive_rho(self, value: bool) -> Settings
[src]
Enables choosing rho adaptively.
pub 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()
.
pub fn adaptive_rho_tolerance(self, value: f64) -> Settings
[src]
Sets the tolerance for adapting rho.
The new rho has to be value
times larger or 1/value
times smaller than the current rho to
trigger a new factorization.
pub fn adaptive_rho_fraction(self, value: f64) -> Settings
[src]
Set the interval for adapting rho as a fraction of the setup time.
pub 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()
.
pub fn eps_abs(self, value: f64) -> Settings
[src]
Sets the absolute convergence tolerance.
pub fn eps_rel(self, value: f64) -> Settings
[src]
Sets the relative convergence tolerance.
pub fn eps_prim_inf(self, value: f64) -> Settings
[src]
Sets the primal infeasibility tolerance.
pub fn eps_dual_inf(self, value: f64) -> Settings
[src]
Sets the dual infeasibility tolerance.
pub fn alpha(self, value: f64) -> Settings
[src]
Sets the linear solver relaxation parameter.
pub fn linsys_solver(self, value: LinsysSolver) -> Settings
[src]
Sets the linear system solver to use.
pub fn delta(self, value: f64) -> Settings
[src]
Sets the polishing regularization parameter.
pub fn polish(self, value: bool) -> Settings
[src]
Enables polishing the ADMM solution.
pub 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()
.
pub fn verbose(self, value: bool) -> Settings
[src]
Enables writing progress to stdout.
pub fn scaled_termination(self, value: bool) -> Settings
[src]
Enables scaled termination criteria.
pub 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()
.
pub fn warm_start(self, value: bool) -> Settings
[src]
Enables warm starting the primal and dual variables from the previous solution.
pub fn time_limit(self, value: Option<Duration>) -> Settings
[src]
Sets the solve time limit.
Trait Implementations
impl Clone for Settings
[src]
impl Default for Settings
[src]
impl Send for Settings
[src]
impl Sync for Settings
[src]
Auto Trait Implementations
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,