Skip to main content

NumericLdl

Struct NumericLdl 

Source
pub struct NumericLdl<T: Real = f64> {
    pub blocks: Vec<DenseBlock<T>>,
    pub diag: Vec<T>,
    pub pivot_2x2: Vec<bool>,
    pub inertia: Inertia,
    pub bumped: usize,
    /* private fields */
}
Expand description

The numeric factor of SupernodalLdl: P K_reg Pᵀ = L̂ Δ̂ L̂ᵀ with L̂ by blocks (column-major, Δ̂ on the diagonal, the unit diagonal of L̂ implicit), in the caller’s units (step N4). For the LDLᵀ of Algorithm N (both regularized systems) Δ̂ is diagonal, the blocks are the symbolic supernodes and P is SymbolicLdl::perm. For the LBLᵀ of Algorithm M (the unregularized augmented system) Δ̂ has 2×2 blocks — pivot_2x2 true on both their columns, e₂₁ stored in the block at the slot (k + 1, k) where L̂ has an implicit zero —, P is the pivot order NumericLdl::perm, and the blocks’ pivot ranges and rows are NumericLdl::supernodes and NumericLdl::rows (delayed pivots move columns between blocks).

Fields§

§blocks: Vec<DenseBlock<T>>

One block per supernode: nrows(s) × ncols(s), column-major.

§diag: Vec<T>

Δ̂ in pivot order (diag[k] = the pivot of permuted column k, in the caller’s units: step N4).

§pivot_2x2: Vec<bool>

2×2 pivot marks, in pivot order: true on both columns of a 2×2 block (LBLᵀ); all false for LDLᵀ.

§inertia: Inertia

The inertia of the factor (S6).

§bumped: usize

Pivots that dynamic regularization bumped (step K3), of both signs, counted as they are bumped.

Implementations§

Source§

impl<T: Real> NumericLdl<T>

Source

pub fn order(&self) -> usize

The order N of the factor.

Source

pub fn n_supernodes(&self) -> usize

Number of supernodes.

Source

pub fn perm(&self) -> &Perm

The permutation of the factor (fwd[k] = the original row of pivot k): the symbolic one (step A2′) for LDLᵀ, the pivot order fwd′ of Algorithm M for LBLᵀ.

Source

pub fn is_pivoted(&self) -> bool

true for an LBLᵀ factor (Algorithm M: 2×2 pivots and delayed pivots possible — the unregularized augmented system), false for the LDLᵀ of Algorithm N.

Source

pub fn delayed(&self) -> usize

Pivots delayed to a parent supernode in Algorithm M (step M5), counted once per delay; 0 for LDLᵀ.

Source

pub fn supernodes(&self) -> &[u32]

The blocks’ boundaries in pivot order (n_supernodes + 1 entries): blocks[s] holds the pivots supernodes()[s]..supernodes()[s + 1]. The symbolic supernodes for LDLᵀ; with delayed pivots a block may hold more or fewer columns than its supernode.

Source

pub fn rows(&self, s: usize) -> &[u32]

The rows of blocks[s] below its diagonal block, in pivot order: row ncols + q of the block is the pivot rows(s)[q] (for LBLᵀ, the delayed rows of the block come first, then its pattern).

Source

pub fn scale(&self) -> &[T]

The equilibration s of step K2′ (powers of two, original numbering): the stored factor is of P K_reg Pᵀ, the pivots of the equilibrated matrix being d_k · s_{fwd[k]}².

Trait Implementations§

Source§

impl<T: Clone + Real> Clone for NumericLdl<T>

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<T: Debug + Real> Debug for NumericLdl<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T = f64> !Freeze for NumericLdl<T>

§

impl<T> RefUnwindSafe for NumericLdl<T>
where T: RefUnwindSafe,

§

impl<T> Send for NumericLdl<T>
where T: Send,

§

impl<T> Sync for NumericLdl<T>
where T: Sync + Send,

§

impl<T> Unpin for NumericLdl<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for NumericLdl<T>

§

impl<T> UnwindSafe for NumericLdl<T>
where T: UnwindSafe,

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
§

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.