Struct nalgebra_lapack::SymmetricEigen

pub struct SymmetricEigen<N: Scalar, D: Dim> where
    DefaultAllocator: Allocator<N, D> + Allocator<N, D, D>,  {
    pub eigenvectors: MatrixN<N, D>,
    pub eigenvalues: VectorN<N, D>,
}

Eigendecomposition of a real square symmetric matrix with real eigenvalues.

Fields

eigenvectors: MatrixN<N, D>

The eigenvectors of the decomposed matrix.

eigenvalues: VectorN<N, D>

The unsorted eigenvalues of the decomposed matrix.

Methods

impl<N: SymmetricEigenScalar + RealField, D: Dim> SymmetricEigen<N, D> where
    DefaultAllocator: Allocator<N, D, D> + Allocator<N, D>, 

pub fn new(m: MatrixN<N, 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: MatrixN<N, 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: MatrixN<N, D>) -> VectorN<N, D>

Computes only the eigenvalues of the input matrix.

Panics if the method does not converge.

pub fn try_eigenvalues(m: MatrixN<N, D>) -> Option<VectorN<N, D>>

Computes only the eigenvalues of the input matrix.

Returns None if the method does not converge.

pub fn determinant(&self) -> N

The determinant of the decomposed matrix.

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

Rebuild the original matrix.

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

Trait Implementations

impl<N: Clone + Scalar, D: Clone + Dim> Clone for SymmetricEigen<N, D> where
    DefaultAllocator: Allocator<N, D> + Allocator<N, D, D>, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Scalar, D: Dim> Copy for SymmetricEigen<N, D> where
    DefaultAllocator: Allocator<N, D, D> + Allocator<N, D>,
    MatrixN<N, D>: Copy,
    VectorN<N, D>: Copy, 

impl<N: Debug + Scalar, D: Debug + Dim> Debug for SymmetricEigen<N, D> where
    DefaultAllocator: Allocator<N, D> + Allocator<N, D, D>, 

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

Formats the value using the given formatter.