Struct nalgebra::linalg::SymmetricEigen

pub struct SymmetricEigen<T: ComplexField, D: Dim>where
    DefaultAllocator: Allocator<T, D, D> + Allocator<T::RealField, D>,{
    pub eigenvectors: OMatrix<T, D, D>,
    pub eigenvalues: OVector<T::RealField, D>,
}

Eigendecomposition of a symmetric matrix.

Fields

eigenvectors: OMatrix<T, D, D>

The eigenvectors of the decomposed matrix.

eigenvalues: OVector<T::RealField, D>

The unsorted eigenvalues of the decomposed matrix.

Implementations

impl<T: ComplexField, D: Dim> SymmetricEigen<T, D>where
    DefaultAllocator: Allocator<T, D, D> + Allocator<T::RealField, D>,

pub fn new(m: OMatrix<T, D, D>) -> Selfwhere
    D: DimSub<U1>,
    DefaultAllocator: Allocator<T, DimDiff<D, U1>> + Allocator<T::RealField, DimDiff<D, U1>>,

Computes the eigendecomposition of the given symmetric matrix.

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

pub fn try_new(
    m: OMatrix<T, D, D>,
    eps: T::RealField,
    max_niter: usize
) -> Option<Self>where
    D: DimSub<U1>,
    DefaultAllocator: Allocator<T, DimDiff<D, U1>> + Allocator<T::RealField, DimDiff<D, U1>>,

Computes the eigendecomposition of the given symmetric matrix with user-specified convergence parameters.

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

Arguments

• eps − tolerance used to determine when a value converged to 0.
• max_niter − maximum total number of iterations performed by the algorithm. If this number of iteration is exceeded, None is returned. If niter == 0, then the algorithm continues indefinitely until convergence.

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

Rebuild the original matrix.

This is useful if some of the eigenvalues have been manually modified.

Trait Implementations

impl<T: Clone + ComplexField, D: Clone + Dim> Clone for SymmetricEigen<T, D>where
    DefaultAllocator: Allocator<T, D, D> + Allocator<T::RealField, D>,
    T::RealField: Clone,

fn clone(&self) -> SymmetricEigen<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 + Dim> Debug for SymmetricEigen<T, D>where
    DefaultAllocator: Allocator<T, D, D> + Allocator<T::RealField, D>,
    T::RealField: Debug,

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

Formats the value using the given formatter.

impl<T: ComplexField, D: Dim> Copy for SymmetricEigen<T, D>where
    DefaultAllocator: Allocator<T, D, D> + Allocator<T::RealField, D>,
    OMatrix<T, D, D>: Copy,
    OVector<T::RealField, D>: Copy,