Skip to main content

SupernodalOptions

Struct SupernodalOptions 

Source
pub struct SupernodalOptions {
    pub relax_zeros: usize,
    pub min_supernode_cols: usize,
    pub supernodal_switch: f64,
    pub zero_pivot_tol: f64,
    pub pivot_threshold: f64,
}
Expand description

Options of the supernodal factorization (steps A5 and N3).

Fields§

§relax_zeros: usize

Relaxed amalgamation (step A5): a child supernode is merged into its parent whenever the merged supernode has at most this many columns, and beyond that when the fraction of explicit zeros it adds stays under CHOLMOD’s cutoffs (RELAX_CUTOFFS); 0 keeps the fundamental supernodes (no explicit zero). Default 4 (CHOLMOD’s nrelax[0]).

§min_supernode_cols: usize

Below this many columns a supernode is handled by the simplicial path (column by column, plain loops) instead of the dense kernel; an update by a descendant narrower than this takes the plain loops too. Default 8.

§supernodal_switch: f64

The simplicial/supernodal switch (step A3′): when the flop count of the factorization per stored entry of L, (Σ_j c_j + Σ_j c_j(c_j+1)/2) / Σ_j c_j, is at most this, the matrix is too sparse for dense blocks to pay: the fundamental supernodes are kept (no relaxation, no explicit zero) and every supernode takes the simplicial path. 0 forces the supernodal structure, ∞ the simplicial one. Default 40 (CHOLMOD’s supernodal_switch, faer’s AUTO).

§zero_pivot_tol: f64

LBLᵀ path only (Algorithm M, step M3): a pivot whose magnitude is at most this fraction of the largest entry of its column in the diagonal block of its supernode is a zero pivot and is delayed to the parent supernode (a 2×2 block: its determinant against the product of the two columns’ largest entries). Relative, so that a pivot that is zero up to rounding is caught and a merely small one is kept. Default 10⁻¹⁴.

§pivot_threshold: f64

LBLᵀ path only (Algorithm M, step M4): the threshold u of the growth test. A pivot whose column of L below the diagonal block has an entry above 1/u is delayed to the parent supernode, where the large entry’s row is a candidate partner (the threshold partial pivoting of MA57 among the fully summed variables). Default 10⁻⁸ (Ipopt’s setting for MA57 on interior-point systems: it stops the growth that turns the pivots below into rounding noise and leaves the merely small pivots of a barrier method alone).

Trait Implementations§

Source§

impl Clone for SupernodalOptions

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 SupernodalOptions

Source§

impl Debug for SupernodalOptions

Source§

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

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

impl Default for SupernodalOptions

Source§

fn default() -> Self

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

impl PartialEq for SupernodalOptions

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 SupernodalOptions

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
§

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
§

impl<T> ByRef<T> for T

§

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.

§

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.