Struct nalgebra::linalg::SymmetricTridiagonal

pub struct SymmetricTridiagonal<T: ComplexField, D: DimSub<U1>> where
    DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>,  { /* fields omitted */ }

Tridiagonalization of a symmetric matrix.

Implementations

impl<T: ComplexField, D: DimSub<U1>> SymmetricTridiagonal<T, D> where
    DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>, 

pub fn new(m: OMatrix<T, D, D>) -> Self

Computes the tridiagonalization of the symmetric matrix m.

Only the lower-triangular part (including the diagonal) of m is read.

pub fn unpack(
    self
) -> (OMatrix<T, D, D>, OVector<T::RealField, D>, OVector<T::RealField, DimDiff<D, U1>>) where
    DefaultAllocator: Allocator<T::RealField, D> + Allocator<T::RealField, DimDiff<D, U1>>, 

Retrieve the orthogonal transformation, diagonal, and off diagonal elements of this decomposition.

pub fn unpack_tridiagonal(
    self
) -> (OVector<T::RealField, D>, OVector<T::RealField, DimDiff<D, U1>>) where
    DefaultAllocator: Allocator<T::RealField, D> + Allocator<T::RealField, DimDiff<D, U1>>, 

Retrieve the diagonal, and off diagonal elements of this decomposition.

pub fn diagonal(&self) -> OVector<T::RealField, D> where
    DefaultAllocator: Allocator<T::RealField, D>, 

The diagonal components of this decomposition.

pub fn off_diagonal(&self) -> OVector<T::RealField, DimDiff<D, U1>> where
    DefaultAllocator: Allocator<T::RealField, DimDiff<D, U1>>, 

The off-diagonal components of this decomposition.

pub fn q(&self) -> OMatrix<T, D, D>

Computes the orthogonal matrix Q of this decomposition.

pub fn recompose(self) -> OMatrix<T, D, D>

Recomputes the original symmetric matrix.

Trait Implementations

impl<T: Clone + ComplexField, D: Clone + DimSub<U1>> Clone for SymmetricTridiagonal<T, D> where
    DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>, 

fn clone(&self) -> SymmetricTridiagonal<T, D>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + ComplexField, D: Debug + DimSub<U1>> Debug for SymmetricTridiagonal<T, D> where
    DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>, 

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, T: ComplexField, D: DimSub<U1>> Deserialize<'de> for SymmetricTridiagonal<T, D> where
    DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>,
    DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>,
    OMatrix<T, D, D>: Deserialize<'de>,
    OVector<T, DimDiff<D, U1>>: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T: ComplexField, D: DimSub<U1>> Serialize for SymmetricTridiagonal<T, D> where
    DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>,
    DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>,
    OMatrix<T, D, D>: Serialize,
    OVector<T, DimDiff<D, U1>>: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T: ComplexField, D: DimSub<U1>> Copy for SymmetricTridiagonal<T, D> where
    DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>,
    OMatrix<T, D, D>: Copy,
    OVector<T, DimDiff<D, U1>>: Copy,