Skip to main content

SparseSolver

Struct SparseSolver 

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

A sparse direct solver for repeated solves on a fixed sparsity pattern.

Cloning shares the cached factorization, whose pivot order and fill pattern are reused across solves until a pivot degrades. Symmetric values use an LDLᵀ factorization, falling back to LU otherwise. Symmetry is a caller-supplied guarantee about the source values, not detected at runtime — a source whose symmetry can vary between solves (e.g. a tangent that is only symmetric near a particular configuration) must be declared asymmetric.

Implementations§

Source§

impl SparseSolver

Source

pub fn from_pattern( num: usize, pattern: Vec<(usize, usize)>, symmetric: bool, ) -> Self

Source

pub fn pattern(&self) -> Ref<'_, [(usize, usize)]>

The nonzero (row, column) positions this structure was built from.

Source

pub fn solve( &self, source: impl FnMut(usize, usize) -> Scalar, b: &Vector, ) -> Result<Vector, SparseError>

Solve a system of linear equations with values from a source, refactoring the cached factorization when possible.

Trait Implementations§

Source§

impl Clone for SparseSolver

Source§

fn clone(&self) -> SparseSolver

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

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