Struct sprs_suitesparse_ldl::LdlSymbolic
source · [−]pub struct LdlSymbolic { /* private fields */ }
Expand description
Structure holding the symbolic ldlt decomposition computed by suitesparse’s ldl
Implementations
sourceimpl LdlSymbolic
impl LdlSymbolic
sourcepub fn new<N, I>(mat: CsMatViewI<'_, N, I>) -> LdlSymbolic where
N: Clone + Into<f64>,
I: SpIndex,
pub fn new<N, I>(mat: CsMatViewI<'_, N, I>) -> LdlSymbolic where
N: Clone + Into<f64>,
I: SpIndex,
sourcepub fn new_perm<N, I>(
mat: CsMatViewI<'_, N, I>,
perm: PermOwnedI<I>,
check_perm: PermutationCheck
) -> LdlSymbolic where
N: Clone + Into<f64>,
I: SpIndex,
pub fn new_perm<N, I>(
mat: CsMatViewI<'_, N, I>,
perm: PermOwnedI<I>,
check_perm: PermutationCheck
) -> LdlSymbolic where
N: Clone + Into<f64>,
I: SpIndex,
Compute the symbolic decomposition L D L^T = P A P^T where P is a permutation matrix.
Using a good permutation matrix can reduce the non-zero count in L, thus making the decomposition and the solves faster.
Panics
- if mat is not symmetric
- if perm does not represent a valid permutation
sourcepub fn problem_size(&self) -> usize
pub fn problem_size(&self) -> usize
The size of the linear system associated with this decomposition
sourcepub fn factor<N, I>(
self,
mat: CsMatViewI<'_, N, I>
) -> Result<LdlNumeric, LinalgError> where
N: Clone + Into<f64>,
I: SpIndex,
pub fn factor<N, I>(
self,
mat: CsMatViewI<'_, N, I>
) -> Result<LdlNumeric, LinalgError> where
N: Clone + Into<f64>,
I: SpIndex,
Factor a matrix, assuming it shares the same nonzero pattern as the matrix this factorization was built from.
Panics
If the matrix is not symmetric.
Trait Implementations
sourceimpl Clone for LdlSymbolic
impl Clone for LdlSymbolic
sourcefn clone(&self) -> LdlSymbolic
fn clone(&self) -> LdlSymbolic
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl RefUnwindSafe for LdlSymbolic
impl Send for LdlSymbolic
impl Sync for LdlSymbolic
impl Unpin for LdlSymbolic
impl UnwindSafe for LdlSymbolic
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Pointable for T
impl<T> Pointable for T
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
unsafe fn to_subset_unchecked(&self) -> SS
unsafe fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.