Skip to main content

AptpNumeric

Struct AptpNumeric 

Source
pub struct AptpNumeric { /* private fields */ }
Expand description

Complete multifrontal numeric factorization result.

Contains per-supernode factors and aggregate statistics. Created by AptpNumeric::factor and used by the triangular solve to perform forward/backward substitution.

§Usage

use faer::sparse::{SparseColMat, Triplet};
use faer::sparse::linalg::cholesky::SymmetricOrdering;
use rivrs_sparse::symmetric::{AptpSymbolic, AptpOptions, AptpNumeric};

// Analyze
let symbolic = AptpSymbolic::analyze(matrix.symbolic(), SymmetricOrdering::Amd).unwrap();

// Factor
let numeric = AptpNumeric::factor(&symbolic, &matrix, &AptpOptions::default(), None).unwrap();
println!("Stats: {:?}", numeric.stats());

Implementations§

Source§

impl AptpNumeric

Source

pub fn front_factors(&self) -> &[FrontFactors]

Per-supernode factors, indexed by supernode ID.

Source

pub fn stats(&self) -> &FactorizationStats

Aggregate factorization statistics.

Source

pub fn per_supernode_stats(&self) -> &[PerSupernodeStats]

Per-supernode diagnostic statistics.

One entry per supernode in postorder, matching front_factors.

Source

pub fn n(&self) -> usize

Matrix dimension.

Source

pub fn factor( symbolic: &AptpSymbolic, matrix: &SparseColMat<usize, f64>, options: &AptpOptions, scaling: Option<&[f64]>, ) -> Result<Self, SparseError>

Factor a sparse symmetric matrix using the multifrontal method with APTP.

Traverses the assembly tree in postorder, assembling and factoring dense frontal matrices at each supernode using the dense APTP kernel.

§Arguments
  • symbolic: Symbolic analysis result from AptpSymbolic::analyze
  • matrix: Sparse symmetric matrix (lower triangle stored). Dimensions must match symbolic.nrows()
  • options: APTP configuration (threshold, fallback strategy)
§Errors
§Zero Pivots

If a root supernode has columns that cannot be eliminated (all pivots delayed to root but still fail the threshold), these are recorded as zero pivots in FactorizationStats::zero_pivots rather than returning an error. The factorization succeeds; the solve phase must handle the rank deficiency.

§References
  • Duff & Reid (1983), “The multifrontal solution of indefinite sparse symmetric linear equations”
  • Liu (1992), “The Multifrontal Method for Sparse Matrix Solution”
  • Hogg, Duff & Lopez (2020), “A New Sparse LDL^T Solver Using A Posteriori Threshold Pivoting”

Trait Implementations§

Source§

impl Debug for AptpNumeric

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> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<T> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,