Struct nalgebra::sparse::CsCholesky
source · pub struct CsCholesky<T: RealField, D: Dim>where
DefaultAllocator: Allocator<usize, D> + Allocator<T, D>,{ /* private fields */ }Expand description
The cholesky decomposition of a column compressed sparse matrix.
Implementations
sourceimpl<T: RealField, D: Dim> CsCholesky<T, D>where
DefaultAllocator: Allocator<usize, D> + Allocator<T, D>,
impl<T: RealField, D: Dim> CsCholesky<T, D>where
DefaultAllocator: Allocator<usize, D> + Allocator<T, D>,
sourcepub fn new(m: &CsMatrix<T, D, D>) -> Self
pub fn new(m: &CsMatrix<T, D, D>) -> Self
Computes the cholesky decomposition of the sparse matrix m.
sourcepub fn new_symbolic(m: &CsMatrix<T, D, D>) -> Self
pub fn new_symbolic(m: &CsMatrix<T, D, D>) -> Self
Perform symbolic analysis for the given matrix.
This does not access the numerical values of m.
sourcepub fn l(&self) -> Option<&CsMatrix<T, D, D>>
pub fn l(&self) -> Option<&CsMatrix<T, D, D>>
The lower-triangular matrix of the cholesky decomposition.
sourcepub fn unwrap_l(self) -> Option<CsMatrix<T, D, D>>
pub fn unwrap_l(self) -> Option<CsMatrix<T, D, D>>
Extracts the lower-triangular matrix of the cholesky decomposition.
sourcepub fn decompose_left_looking(&mut self, values: &[T]) -> bool
pub fn decompose_left_looking(&mut self, values: &[T]) -> bool
Perform a numerical left-looking cholesky decomposition of a matrix with the same structure as the
one used to initialize self, but with different non-zero values provided by values.
sourcepub fn decompose_up_looking(&mut self, values: &[T]) -> bool
pub fn decompose_up_looking(&mut self, values: &[T]) -> bool
Perform a numerical up-looking cholesky decomposition of a matrix with the same structure as the
one used to initialize self, but with different non-zero values provided by values.
Auto Trait Implementations
impl<T, D> !RefUnwindSafe for CsCholesky<T, D>
impl<T, D> !Send for CsCholesky<T, D>
impl<T, D> !Sync for CsCholesky<T, D>
impl<T, D> !Unpin for CsCholesky<T, D>
impl<T, D> !UnwindSafe for CsCholesky<T, D>
Blanket Implementations
sourceimpl<T> ArchivePointee for T
impl<T> ArchivePointee for T
type ArchivedMetadata = ()
type ArchivedMetadata = ()
The archived version of the pointer metadata for this type.
sourcefn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata
fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata
Converts some archived metadata to the pointer metadata for itself.
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
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
sourceimpl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,
impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,
sourceimpl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
sourcefn 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 moresourcefn 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).sourcefn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.sourcefn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.sourceimpl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
sourcefn 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 moresourcefn 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).sourceunsafe 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.sourcefn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.