Struct nalgebra::linalg::SymmetricTridiagonal
source · pub struct SymmetricTridiagonal<N: Real, D: DimSub<U1>>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,{ /* private fields */ }
Expand description
Tridiagonalization of a symmetric matrix.
Implementations§
source§impl<N: Real, D: DimSub<U1>> SymmetricTridiagonal<N, D>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,
impl<N: Real, D: DimSub<U1>> SymmetricTridiagonal<N, D>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,
sourcepub fn new(m: MatrixN<N, D>) -> Self
pub fn new(m: MatrixN<N, D>) -> Self
Computes the tridiagonalization of the symmetric matrix m
.
Only the lower-triangular part (including the diagonal) of m
is read.
sourcepub fn unpack(
self
) -> (MatrixN<N, D>, VectorN<N, D>, VectorN<N, DimDiff<D, U1>>)where
DefaultAllocator: Allocator<N, D>,
pub fn unpack(
self
) -> (MatrixN<N, D>, VectorN<N, D>, VectorN<N, DimDiff<D, U1>>)where
DefaultAllocator: Allocator<N, D>,
Retrieve the orthogonal transformation, diagonal, and off diagonal elements of this decomposition.
sourcepub fn unpack_tridiagonal(self) -> (VectorN<N, D>, VectorN<N, DimDiff<D, U1>>)where
DefaultAllocator: Allocator<N, D>,
pub fn unpack_tridiagonal(self) -> (VectorN<N, D>, VectorN<N, DimDiff<D, U1>>)where
DefaultAllocator: Allocator<N, D>,
Retrieve the diagonal, and off diagonal elements of this decomposition.
sourcepub fn diagonal(&self) -> VectorN<N, D>where
DefaultAllocator: Allocator<N, D>,
pub fn diagonal(&self) -> VectorN<N, D>where
DefaultAllocator: Allocator<N, D>,
The diagonal components of this decomposition.
sourcepub fn off_diagonal(&self) -> &VectorN<N, DimDiff<D, U1>>where
DefaultAllocator: Allocator<N, D>,
pub fn off_diagonal(&self) -> &VectorN<N, DimDiff<D, U1>>where
DefaultAllocator: Allocator<N, D>,
The off-diagonal components of this decomposition.
Trait Implementations§
source§impl<N: Clone + Real, D: Clone + DimSub<U1>> Clone for SymmetricTridiagonal<N, D>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,
impl<N: Clone + Real, D: Clone + DimSub<U1>> Clone for SymmetricTridiagonal<N, D>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,
source§fn clone(&self) -> SymmetricTridiagonal<N, D>
fn clone(&self) -> SymmetricTridiagonal<N, D>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<N: Debug + Real, D: Debug + DimSub<U1>> Debug for SymmetricTridiagonal<N, D>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,
impl<N: Debug + Real, D: Debug + DimSub<U1>> Debug for SymmetricTridiagonal<N, D>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,
impl<N: Real, D: DimSub<U1>> Copy for SymmetricTridiagonal<N, D>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,
MatrixN<N, D>: Copy,
VectorN<N, DimDiff<D, U1>>: Copy,
Auto Trait Implementations§
impl<N, D> !RefUnwindSafe for SymmetricTridiagonal<N, D>
impl<N, D> !Send for SymmetricTridiagonal<N, D>
impl<N, D> !Sync for SymmetricTridiagonal<N, D>
impl<N, D> !Unpin for SymmetricTridiagonal<N, D>
impl<N, D> !UnwindSafe for SymmetricTridiagonal<N, D>
Blanket Implementations§
source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
source§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 moresource§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).source§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.source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.