Skip to main content

FactorPattern

Struct FactorPattern 

Source
pub struct FactorPattern {
    pub n: usize,
    pub perm: Vec<usize>,
    pub l_irn: Vec<Index>,
    pub l_jcn: Vec<Index>,
    pub l_vals: Option<Vec<Number>>,
}
Expand description

Snapshot of the most recent LDLᵀ factor’s sparsity pattern (and optionally values) plus the fill-reducing permutation. Backends produce this on demand from SparseSymLinearSolverInterface::factor_pattern — it is purely diagnostic and is not part of the solve / refine hot path.

All irn / jcn indices are 1-based in permuted coordinates (i.e. they reference the matrix Pᵀ K P that the backend actually factored, not the original-variable ordering). The perm array closes the loop: perm[k] = original_row for the k-th permuted row, so a consumer can render the L pattern in either coordinate system. perm is 0-based to keep the array directly indexable.

Only the strict lower triangle of L is populated — the unit diagonal is implicit (L_ii = 1).

Fields§

§n: usize

Matrix dimension (rows = cols).

§perm: Vec<usize>

Fill-reducing permutation, 0-based, length n. perm[k] is the original-variable row that landed at permuted-row k.

§l_irn: Vec<Index>

Row indices of L’s strict-lower nonzeros, 1-based, permuted coordinates.

§l_jcn: Vec<Index>

Column indices of L’s strict-lower nonzeros, 1-based, permuted coordinates. Same length as l_irn.

§l_vals: Option<Vec<Number>>

Optional numerical values aligned with l_irn / l_jcn. None when only the pattern was requested.

Trait Implementations§

Source§

impl Clone for FactorPattern

Source§

fn clone(&self) -> FactorPattern

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 FactorPattern

Source§

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

Formats the value using the given formatter. Read more

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> 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> 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> 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> 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