Skip to main content

LuOptions

Struct LuOptions 

Source
pub struct LuOptions {
    pub abs_pivot_tol: f64,
    pub rel_pivot_tol: f64,
    pub search_limit: usize,
    pub growth_limit: f64,
    pub fill_factor: f64,
    pub refactor_interval: usize,
    pub update_stability_tol: f64,
    pub hyper_rhs_density: f64,
    pub hyper_result_density: f64,
    pub drop_tol: f64,
}
Expand description

Options of the factorization, of the solves and of the update policy.

The names follow the contract (D-0080); the defaults are those of the first edition (FactorOptions and the two fields of the solver’s Tolerances it read), so a default Lu behaves exactly as the first edition’s default Factor.

Fields§

§abs_pivot_tol: f64

Absolute pivot tolerance τ_abs: no pivot of magnitude at or below it is accepted, in the factorization or in an update (1e-10).

Absolute, in the units of B: an unscaled matrix whose columns hold only tiny entries is declared singular. The Harwell–Boeing matrix sherman3 has 2 107 of its 5 005 columns with largest entry 10⁻¹⁰ (inactive cells of a reservoir model) and is reported with rank deficiency 2 107, while SuperLU, which has no absolute threshold, factorizes it. Scale first (crate::Scaling: with Geometric { max_iters: 4, power_of_two: true } it factorizes with the defaults, residual 5·10⁻¹²), or lower τ_abs (10⁻¹²: residual 7·10⁻¹⁷; task L1.5b, D9). The simplex method scales its computational form when it is badly scaled (ScaleMode::Auto, Chapter 6.9) before it factorizes.

§rel_pivot_tol: f64

Relative threshold u ∈ (0, 1] of Markowitz threshold pivoting (1e-2; the solver’s Tolerances::markowitz).

§search_limit: usize

Number of lines with an acceptable entry after which the Markowitz search stops (4, Zlatev’s restriction; at least 1).

§growth_limit: f64

Growth limit (1e10): the factor is flagged (LuStats::growth_exceeded) when max |u_ij| / max |b_ij| exceeds it, and an update asks for a refactorization when the growth added by the updates, UpdateStats::update_growth, exceeds it (Chapter 5.5, refactorization policy).

§fill_factor: f64

Fill trigger: an update asks for a refactorization when nnz(L) + nnz(U) + nnz(etas) exceeds this multiple of nnz(L) + nnz(U) right after the factorization (3.0).

§refactor_interval: usize

Number of updates after which a refactorization is requested (100).

§update_stability_tol: f64

Relative tolerance of the Forrest–Tomlin stability test: the new diagonal must agree with α_r · u_old within this relative distance (1e-8).

§hyper_rhs_density: f64

Largest right-hand side density (count/m) for which a solve may use the hypersparse algorithms (Chapter 5.4, policy (b); 0.10). A negative value disables them.

§hyper_result_density: f64

Largest expected result density for which a solve may use the hypersparse algorithms (Chapter 5.4, policy (c); 0.10).

§drop_tol: f64

Drop tolerance ε_drop: magnitudes at or below it are treated as zero by the elimination and the update (1e-12; the solver’s Tolerances::zero).

Trait Implementations§

Source§

impl Clone for LuOptions

Source§

fn clone(&self) -> Self

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 Copy for LuOptions

Source§

impl Debug for LuOptions

Source§

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

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

impl Default for LuOptions

Source§

fn default() -> Self

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

impl PartialEq for LuOptions

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for LuOptions

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> Boilerplate for T
where T: Copy + Send + Sync + Debug + PartialEq + 'static,

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, 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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.