Struct SymmetricEigen

pub struct SymmetricEigen<T, D>
where
    T: ComplexField,
    D: Dim,
    DefaultAllocator: Allocator<D, D> + Allocator<D>,
{
    pub eigenvectors: Matrix<T, D, D, <DefaultAllocator as Allocator<D, D>>::Buffer<T>>,
    pub eigenvalues: Matrix<<T as ComplexField>::RealField, D, Const<1>, <DefaultAllocator as Allocator<D>>::Buffer<<T as ComplexField>::RealField>>,
}

Eigendecomposition of a symmetric matrix.

Fields

eigenvectors: Matrix<T, D, D, <DefaultAllocator as Allocator<D, D>>::Buffer<T>>

The eigenvectors of the decomposed matrix.

eigenvalues: Matrix<<T as ComplexField>::RealField, D, Const<1>, <DefaultAllocator as Allocator<D>>::Buffer<<T as ComplexField>::RealField>>

The unsorted eigenvalues of the decomposed matrix.

Implementations

impl<T, D> SymmetricEigen<T, D>

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

pub fn new( m: Matrix<T, D, D, <DefaultAllocator as Allocator<D, D>>::Buffer<T>>, ) -> SymmetricEigen<T, D>

where D: DimSub<Const<1>>, DefaultAllocator: Allocator<<D as DimSub<Const<1>>>::Output>,

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: Matrix<T, D, D, <DefaultAllocator as Allocator<D, D>>::Buffer<T>>, eps: <T as ComplexField>::RealField, max_niter: usize, ) -> Option<SymmetricEigen<T, D>>

where D: DimSub<Const<1>>, DefaultAllocator: Allocator<<D as DimSub<Const<1>>>::Output>,

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, ) -> Matrix<T, D, D, <DefaultAllocator as Allocator<D, D>>::Buffer<T>>

Rebuild the original matrix.

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

Trait Implementations

impl<T, D> Clone for SymmetricEigen<T, D>

where T: Clone + ComplexField, D: Clone + Dim, DefaultAllocator: Allocator<D, D> + Allocator<D>, <T as ComplexField>::RealField: Clone,

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, D> Debug for SymmetricEigen<T, D>

where T: Debug + ComplexField, D: Debug + Dim, DefaultAllocator: Allocator<D, D> + Allocator<D>, <T as ComplexField>::RealField: Debug,

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

Formats the value using the given formatter.

impl<'de, T, D> Deserialize<'de> for SymmetricEigen<T, D>

where T: ComplexField, D: Dim, DefaultAllocator: Allocator<D, D> + Allocator<D>, Matrix<<T as ComplexField>::RealField, D, Const<1>, <DefaultAllocator as Allocator<D>>::Buffer<<T as ComplexField>::RealField>>: Deserialize<'de>, Matrix<T, D, D, <DefaultAllocator as Allocator<D, D>>::Buffer<T>>: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<SymmetricEigen<T, D>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, D> Serialize for SymmetricEigen<T, D>

where T: ComplexField, D: Dim, DefaultAllocator: Allocator<D, D> + Allocator<D>, Matrix<<T as ComplexField>::RealField, D, Const<1>, <DefaultAllocator as Allocator<D>>::Buffer<<T as ComplexField>::RealField>>: Serialize, Matrix<T, D, D, <DefaultAllocator as Allocator<D, D>>::Buffer<T>>: Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T, D> Copy for SymmetricEigen<T, D>

where T: ComplexField, D: Dim, DefaultAllocator: Allocator<D, D> + Allocator<D>, Matrix<T, D, D, <DefaultAllocator as Allocator<D, D>>::Buffer<T>>: Copy, Matrix<<T as ComplexField>::RealField, D, Const<1>, <DefaultAllocator as Allocator<D>>::Buffer<<T as ComplexField>::RealField>>: Copy,