Struct nalgebra::linalg::SymmetricTridiagonal

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

Tridiagonalization of a symmetric matrix.

Implementations

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

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.

pub fn unpack(
    self
) -> (MatrixN<N, D>, VectorN<N::RealField, D>, VectorN<N::RealField, DimDiff<D, U1>>) where
    DefaultAllocator: Allocator<N::RealField, D> + Allocator<N::RealField, DimDiff<D, U1>>, 

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

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

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

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

The diagonal components of this decomposition.

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

The off-diagonal components of this decomposition.

pub fn q(&self) -> MatrixN<N, D>

Computes the orthogonal matrix Q of this decomposition.

pub fn recompose(self) -> MatrixN<N, D>

Recomputes the original symmetric matrix.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<'de, N: ComplexField, D: DimSub<U1>> Deserialize<'de> for SymmetricTridiagonal<N, D> where
    DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,
    DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,
    MatrixN<N, D>: Deserialize<'de>,
    VectorN<N, 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<N: ComplexField, D: DimSub<U1>> Serialize for SymmetricTridiagonal<N, D> where
    DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,
    DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,
    MatrixN<N, D>: Serialize,
    VectorN<N, 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<N: ComplexField, 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,