Skip to main content

LinearSolverSummary

Struct LinearSolverSummary 

Source
pub struct LinearSolverSummary {
    pub solver_name: String,
    pub n_factors: u64,
    pub n_pattern_reuse: u64,
    pub n_pattern_changes: u64,
    pub max_fill_ratio: Option<f64>,
    pub min_abs_pivot: Option<f64>,
    pub max_abs_pivot: Option<f64>,
    pub last_inertia: Option<(usize, usize, usize)>,
    pub last_nnz_a: Option<usize>,
    pub last_nnz_l: Option<usize>,
}
Expand description

Aggregate stats accumulated over the lifetime of one linear-solver instance. All fields default to zero / None so a backend that declines to populate them still produces a valid summary.

Fields§

§solver_name: String

Short identifier of the backend that produced this summary: "feral", "ma57", etc. Empty for the Default value.

§n_factors: u64

Number of factor() calls completed (including those that reused the cached symbolic factorisation).

§n_pattern_reuse: u64

Of n_factors, how many reused the previous symbolic factorisation (sparsity pattern unchanged). Healthy IPM workloads expect this to dominate after the first iter.

§n_pattern_changes: u64

Of n_factors, how many required a fresh symbolic factorisation (sparsity pattern changed). Inverse of n_pattern_reuse modulo the very first factor.

§max_fill_ratio: Option<f64>

Maximum nnz(L) / nnz(A) observed across factors. Values much greater than ~10 on KKT-style systems indicate ordering trouble.

§min_abs_pivot: Option<f64>

Minimum |pivot| observed across factors. Approaches the working-precision floor when the matrix is near-singular.

§max_abs_pivot: Option<f64>

Maximum |pivot| observed across factors.

§last_inertia: Option<(usize, usize, usize)>

Inertia of the final factorisation as (positive, negative, zero).

§last_nnz_a: Option<usize>

nnz(A) of the final factorisation’s matrix.

§last_nnz_l: Option<usize>

nnz(L) of the final factorisation.

Implementations§

Source§

impl LinearSolverSummary

Source

pub fn is_empty(&self) -> bool

Returns true if the summary carries no signal beyond the solver name — useful for “did we collect anything?” checks.

Trait Implementations§

Source§

impl Clone for LinearSolverSummary

Source§

fn clone(&self) -> LinearSolverSummary

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 LinearSolverSummary

Source§

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

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

impl Default for LinearSolverSummary

Source§

fn default() -> LinearSolverSummary

Returns the “default value” for a type. 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