Struct SymmetricEigen

pub struct SymmetricEigen<T: ComplexField, D: Dim>
where
    DefaultAllocator: Allocator<D, D> + Allocator<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<D, D> + Allocator<D>,

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

where D: DimSub<U1>, DefaultAllocator: Allocator<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<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<D, D> + Allocator<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<D, D> + Allocator<D>, T::RealField: Debug,

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

Formats the value using the given formatter.

impl<'de, T: ComplexField, D: Dim> Deserialize<'de> for SymmetricEigen<T, D>

where DefaultAllocator: Allocator<D, D> + Allocator<D>, OVector<T::RealField, D>: Deserialize<'de>, OMatrix<T, D, D>: 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: Dim> Serialize for SymmetricEigen<T, D>

where DefaultAllocator: Allocator<D, D> + Allocator<D>, OVector<T::RealField, D>: Serialize, OMatrix<T, D, D>: 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: Dim> Copy for SymmetricEigen<T, D>

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