Skip to main content

PounceOptions

Struct PounceOptions 

Source
pub struct PounceOptions {
    pub universal: UniversalOptions,
    pub tol: Option<f64>,
    pub max_iter: Option<u32>,
    pub print_level: Option<u32>,
    pub mu_strategy: Option<MuStrategy>,
    pub algorithm: Option<PounceAlgorithm>,
    pub extra: Vec<(String, PounceOptionValue)>,
    /* private fields */
}
Expand description

POUNCE-specific solver options.

For more information about POUNCE’s options, see the documented option reference.

Invalid option names or out-of-range values are reported by POUNCE and surface as a SolverError::Backend at solve time.

UniversalOptions mapping: time_limit -> max_cpu_time, verbose -> print_level 5 (else 0) and captures the iteration log into SolverResult::raw_log, threads is ignored.

Fields§

§universal: UniversalOptions§tol: Option<f64>

Desired convergence tolerance (tol).

§max_iter: Option<u32>

Iteration limit (max_iter).

§print_level: Option<u32>

Output verbosity 0–12 (print_level); overrides verbose.

§mu_strategy: Option<MuStrategy>

Barrier parameter update strategy (mu_strategy).

§algorithm: Option<PounceAlgorithm>

POUNCE’s top-level solve algorithm. Defaults to the interior-point method when omitted.

§extra: Vec<(String, PounceOptionValue)>

Escape hatch: raw POUNCE options applied last.

Implementations§

Source§

impl PounceOptions

Source

pub fn mu_oracle(self, v: impl Into<String>) -> Self

Set the POUNCE mu_oracle option.

Source

pub fn mu_init(self, v: f64) -> Self

Set the POUNCE mu_init option.

Source

pub fn mu_min(self, v: f64) -> Self

Set the POUNCE mu_min option.

Source

pub fn mu_max(self, v: f64) -> Self

Set the POUNCE mu_max option.

Source

pub fn mu_max_fact(self, v: f64) -> Self

Set the POUNCE mu_max_fact option.

Source

pub fn mu_target(self, v: f64) -> Self

Set the POUNCE mu_target option.

Source

pub fn mu_linear_decrease_factor(self, v: f64) -> Self

Set the POUNCE mu_linear_decrease_factor option.

Source

pub fn mu_superlinear_decrease_power(self, v: f64) -> Self

Set the POUNCE mu_superlinear_decrease_power option.

Source

pub fn barrier_tol_factor(self, v: f64) -> Self

Set the POUNCE barrier_tol_factor option.

Source

pub fn sigma_max(self, v: f64) -> Self

Set the POUNCE sigma_max option.

Source

pub fn sigma_min(self, v: f64) -> Self

Set the POUNCE sigma_min option.

Source

pub fn adaptive_mu_globalization(self, v: impl Into<String>) -> Self

Set the POUNCE adaptive_mu_globalization option.

Source

pub fn quality_function_norm_type(self, v: impl Into<String>) -> Self

Set the POUNCE quality_function_norm_type option.

Source

pub fn quality_function_centrality(self, v: impl Into<String>) -> Self

Set the POUNCE quality_function_centrality option.

Source

pub fn quality_function_balancing_term(self, v: impl Into<String>) -> Self

Set the POUNCE quality_function_balancing_term option.

Source

pub fn quality_function_max_section_steps(self, v: i32) -> Self

Set the POUNCE quality_function_max_section_steps option.

Source

pub fn quality_function_section_sigma_tol(self, v: f64) -> Self

Set the POUNCE quality_function_section_sigma_tol option.

Source

pub fn quality_function_section_qf_tol(self, v: f64) -> Self

Set the POUNCE quality_function_section_qf_tol option.

Source

pub fn adaptive_mu_safeguard_factor(self, v: f64) -> Self

Set the POUNCE adaptive_mu_safeguard_factor option.

Source

pub fn adaptive_mu_monotone_init_factor(self, v: f64) -> Self

Set the POUNCE adaptive_mu_monotone_init_factor option.

Source

pub fn adaptive_mu_restore_previous_iterate(self, v: bool) -> Self

Set the POUNCE adaptive_mu_restore_previous_iterate option.

Source

pub fn adaptive_mu_kkterror_red_iters(self, v: i32) -> Self

Set the POUNCE adaptive_mu_kkterror_red_iters option.

Source

pub fn adaptive_mu_kkterror_red_fact(self, v: f64) -> Self

Set the POUNCE adaptive_mu_kkterror_red_fact option.

Source

pub fn adaptive_mu_kkt_norm_type(self, v: impl Into<String>) -> Self

Set the POUNCE adaptive_mu_kkt_norm_type option.

Source

pub fn l1_exact_penalty_barrier(self, v: bool) -> Self

Set the POUNCE l1_exact_penalty_barrier option.

Source

pub fn l1_fallback_on_restoration_failure(self, v: bool) -> Self

Set the POUNCE l1_fallback_on_restoration_failure option.

Source

pub fn l1_penalty_init(self, v: f64) -> Self

Set the POUNCE l1_penalty_init option.

Source

pub fn l1_penalty_max(self, v: f64) -> Self

Set the POUNCE l1_penalty_max option.

Source

pub fn l1_penalty_increase_factor(self, v: f64) -> Self

Set the POUNCE l1_penalty_increase_factor option.

Source

pub fn l1_penalty_max_outer_iter(self, v: i32) -> Self

Set the POUNCE l1_penalty_max_outer_iter option.

Source

pub fn l1_slack_tol(self, v: f64) -> Self

Set the POUNCE l1_slack_tol option.

Source

pub fn l1_steering_factor(self, v: f64) -> Self

Set the POUNCE l1_steering_factor option.

Source

pub fn presolve(self, v: bool) -> Self

Set the POUNCE presolve option.

Source

pub fn presolve_bound_tightening(self, v: bool) -> Self

Set the POUNCE presolve_bound_tightening option.

Source

pub fn presolve_redundant_constraint_removal(self, v: bool) -> Self

Set the POUNCE presolve_redundant_constraint_removal option.

Source

pub fn presolve_linear_eq_reduction(self, v: bool) -> Self

Set the POUNCE presolve_linear_eq_reduction option.

Source

pub fn presolve_licq_check(self, v: bool) -> Self

Set the POUNCE presolve_licq_check option.

Source

pub fn presolve_licq_action(self, v: impl Into<String>) -> Self

Set the POUNCE presolve_licq_action option.

Source

pub fn presolve_warm_z_bounds(self, v: bool) -> Self

Set the POUNCE presolve_warm_z_bounds option.

Source

pub fn presolve_bound_mult_init_val(self, v: f64) -> Self

Set the POUNCE presolve_bound_mult_init_val option.

Source

pub fn presolve_max_passes(self, v: i32) -> Self

Set the POUNCE presolve_max_passes option.

Source

pub fn presolve_print_level(self, v: i32) -> Self

Set the POUNCE presolve_print_level option.

Source

pub fn presolve_fbbt(self, v: bool) -> Self

Set the POUNCE presolve_fbbt option.

Source

pub fn fbbt_tol(self, v: f64) -> Self

Set the POUNCE fbbt_tol option.

Source

pub fn fbbt_max_iter(self, v: i32) -> Self

Set the POUNCE fbbt_max_iter option.

Source

pub fn fbbt_max_constraints(self, v: i32) -> Self

Set the POUNCE fbbt_max_constraints option.

Source

pub fn presolve_auxiliary(self, v: bool) -> Self

Set the POUNCE presolve_auxiliary option.

Source

pub fn presolve_auxiliary_coupling(self, v: impl Into<String>) -> Self

Set the POUNCE presolve_auxiliary_coupling option.

Source

pub fn presolve_auxiliary_tol(self, v: f64) -> Self

Set the POUNCE presolve_auxiliary_tol option.

Source

pub fn presolve_auxiliary_max_block_dim(self, v: i32) -> Self

Set the POUNCE presolve_auxiliary_max_block_dim option.

Source

pub fn presolve_auxiliary_wall_time_fraction(self, v: f64) -> Self

Set the POUNCE presolve_auxiliary_wall_time_fraction option.

Source

pub fn presolve_auxiliary_diagnostics(self, v: bool) -> Self

Set the POUNCE presolve_auxiliary_diagnostics option.

Source

pub fn linear_solver(self, v: impl Into<String>) -> Self

Set the POUNCE linear_solver option.

Source

pub fn feral_ordering(self, v: impl Into<String>) -> Self

Set the POUNCE feral_ordering option.

Source

pub fn feral_scaling(self, v: impl Into<String>) -> Self

Set the POUNCE feral_scaling option.

Source

pub fn feral_pivtol(self, v: f64) -> Self

Set the POUNCE feral_pivtol option.

Source

pub fn feral_refine(self, v: bool) -> Self

Set the POUNCE feral_refine option.

Source

pub fn feral_cascade_break(self, v: bool) -> Self

Set the POUNCE feral_cascade_break option.

Source

pub fn feral_fma(self, v: bool) -> Self

Set the POUNCE feral_fma option.

Source

pub fn feral_singular_pivot_floor(self, v: f64) -> Self

Set the POUNCE feral_singular_pivot_floor option.

Source

pub fn tol(self, tol: f64) -> Self

Source

pub fn max_iter(self, n: u32) -> Self

Source

pub fn print_level(self, level: u32) -> Self

Source

pub fn mu_strategy(self, s: MuStrategy) -> Self

Source

pub fn algorithm(self, algorithm: PounceAlgorithm) -> Self

Select POUNCE’s top-level algorithm.

Source

pub fn set( self, name: impl Into<String>, value: impl Into<PounceOptionValue>, ) -> Self

Set a raw POUNCE option by name (the escape hatch for anything not covered by a typed setter). Applied last, so it overrides the typed options. An unknown name or invalid value fails the solve.

Trait Implementations§

Source§

impl Clone for PounceOptions

Source§

fn clone(&self) -> PounceOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PounceOptions

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for PounceOptions

Source§

fn default() -> PounceOptions

Returns the “default value” for a type. Read more
Source§

impl HasUniversal for PounceOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UniversalOptionsExt for T
where T: HasUniversal,

Source§

fn time_limit(self, d: Duration) -> Self

Source§

fn threads(self, n: u32) -> Self

Source§

fn verbose(self, on: bool) -> Self

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more