Struct na::linalg::SymmetricTridiagonal
source · [−]pub struct SymmetricTridiagonal<T, D> where
T: ComplexField,
D: DimSub<Const<1_usize>>,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<T, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>, { /* private fields */ }
Expand description
Tridiagonalization of a symmetric matrix.
Implementations
sourceimpl<T, D> SymmetricTridiagonal<T, D> where
T: ComplexField,
D: DimSub<Const<1_usize>>,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<T, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
impl<T, D> SymmetricTridiagonal<T, D> where
T: ComplexField,
D: DimSub<Const<1_usize>>,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<T, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
sourcepub fn new(
m: Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>
) -> SymmetricTridiagonal<T, D>
pub fn new(
m: Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>
) -> SymmetricTridiagonal<T, D>
Computes the tridiagonalization of the symmetric matrix m
.
Only the lower-triangular part (including the diagonal) of m
is read.
sourcepub fn unpack(
self
) -> (Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>, Matrix<<T as ComplexField>::RealField, D, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>>::Buffer>, Matrix<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>>::Buffer>) where
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
pub fn unpack(
self
) -> (Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>, Matrix<<T as ComplexField>::RealField, D, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>>::Buffer>, Matrix<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>>::Buffer>) where
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
Retrieve the orthogonal transformation, diagonal, and off diagonal elements of this decomposition.
sourcepub fn unpack_tridiagonal(
self
) -> (Matrix<<T as ComplexField>::RealField, D, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>>::Buffer>, Matrix<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>>::Buffer>) where
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
pub fn unpack_tridiagonal(
self
) -> (Matrix<<T as ComplexField>::RealField, D, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>>::Buffer>, Matrix<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>>::Buffer>) where
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
Retrieve the diagonal, and off diagonal elements of this decomposition.
sourcepub fn diagonal(
&self
) -> Matrix<<T as ComplexField>::RealField, D, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>>::Buffer> where
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
pub fn diagonal(
&self
) -> Matrix<<T as ComplexField>::RealField, D, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>>::Buffer> where
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
The diagonal components of this decomposition.
sourcepub fn off_diagonal(
&self
) -> Matrix<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>>::Buffer> where
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
pub fn off_diagonal(
&self
) -> Matrix<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>>::Buffer> where
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
The off-diagonal components of this decomposition.
Trait Implementations
sourceimpl<T, D> Clone for SymmetricTridiagonal<T, D> where
T: Clone + ComplexField,
D: Clone + DimSub<Const<1_usize>>,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<T, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
impl<T, D> Clone for SymmetricTridiagonal<T, D> where
T: Clone + ComplexField,
D: Clone + DimSub<Const<1_usize>>,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<T, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
sourcefn clone(&self) -> SymmetricTridiagonal<T, D>
fn clone(&self) -> SymmetricTridiagonal<T, D>
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
sourceimpl<T, D> Debug for SymmetricTridiagonal<T, D> where
T: Debug + ComplexField,
D: Debug + DimSub<Const<1_usize>>,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<T, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
impl<T, D> Debug for SymmetricTridiagonal<T, D> where
T: Debug + ComplexField,
D: Debug + DimSub<Const<1_usize>>,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<T, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
impl<T, D> Copy for SymmetricTridiagonal<T, D> where
T: ComplexField,
D: DimSub<Const<1_usize>>,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<T, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>: Copy,
Matrix<T, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>, <DefaultAllocator as Allocator<T, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>>::Buffer>: Copy,
Auto Trait Implementations
impl<T, D> !RefUnwindSafe for SymmetricTridiagonal<T, D>
impl<T, D> !Send for SymmetricTridiagonal<T, D>
impl<T, D> !Sync for SymmetricTridiagonal<T, D>
impl<T, D> !Unpin for SymmetricTridiagonal<T, D>
impl<T, D> !UnwindSafe for SymmetricTridiagonal<T, D>
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
sourceimpl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
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 more
sourcefn 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<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more