Struct SymmetricEigen

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

Eigendecomposition of a real square symmetric matrix with real eigenvalues.

Fields

eigenvectors: OMatrix<T, D, D>

The eigenvectors of the decomposed matrix.

eigenvalues: OVector<T, D>

The unsorted eigenvalues of the decomposed matrix.

Implementations

impl<T: SymmetricEigenScalar + RealField, D: Dim> SymmetricEigen<T, D>

where DefaultAllocator: Allocator<D, D> + Allocator<D>,

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

Computes the eigenvalues and eigenvectors of the symmetric matrix m.

Only the lower-triangular part of m is read. If eigenvectors is false then, the eigenvectors are not computed explicitly. Panics if the method did not converge.

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

Computes the eigenvalues and eigenvectors of the symmetric matrix m.

Only the lower-triangular part of m is read. If eigenvectors is false then, the eigenvectors are not computed explicitly. Returns None if the method did not converge.

pub fn eigenvalues(m: OMatrix<T, D, D>) -> OVector<T, D>

Computes only the eigenvalues of the input matrix.

Panics if the method does not converge.

pub fn try_eigenvalues(m: OMatrix<T, D, D>) -> Option<OVector<T, D>>

Computes only the eigenvalues of the input matrix.

Returns None if the method does not converge.

pub fn determinant(&self) -> T

The determinant of the decomposed matrix.

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 + Scalar, D: Clone + Dim> Clone for SymmetricEigen<T, D>

where DefaultAllocator: Allocator<D> + Allocator<D, D>,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Scalar, D: Debug + Dim> Debug for SymmetricEigen<T, D>

where DefaultAllocator: Allocator<D> + Allocator<D, D>,

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

Formats the value using the given formatter.

impl<T: Scalar + Copy, D: Dim> Copy for SymmetricEigen<T, D>

where DefaultAllocator: Allocator<D, D> + Allocator<D>, OMatrix<T, D, D>: Copy, OVector<T, D>: Copy,