Struct rin::math::SymmetricEigen

pub struct SymmetricEigen<N, D> where
    N: ComplexField,
    D: Dim,
    DefaultAllocator: Allocator<N, D, D>,
    DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,  {
    pub eigenvectors: Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>,
    pub eigenvalues: Matrix<<N as ComplexField>::RealField, D, U1, <DefaultAllocator as Allocator<<N as ComplexField>::RealField, D, U1>>::Buffer>,
}

Eigendecomposition of a symmetric matrix.

Fields

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

The eigenvectors of the decomposed matrix.

eigenvalues: Matrix<<N as ComplexField>::RealField, D, U1, <DefaultAllocator as Allocator<<N as ComplexField>::RealField, D, U1>>::Buffer>

The unsorted eigenvalues of the decomposed matrix.

Implementations

impl<N, D> SymmetricEigen<N, D> where
    N: ComplexField,
    D: Dim,
    DefaultAllocator: Allocator<N, D, D>,
    DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>, 

pub fn new(
    m: Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>
) -> SymmetricEigen<N, D> where
    D: DimSub<U1>,
    DefaultAllocator: Allocator<N, <D as DimSub<U1>>::Output, U1>,
    DefaultAllocator: Allocator<<N as ComplexField>::RealField, <D as DimSub<U1>>::Output, 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: Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>,
    eps: <N as ComplexField>::RealField,
    max_niter: usize
) -> Option<SymmetricEigen<N, D>> where
    D: DimSub<U1>,
    DefaultAllocator: Allocator<N, <D as DimSub<U1>>::Output, U1>,
    DefaultAllocator: Allocator<<N as ComplexField>::RealField, <D as DimSub<U1>>::Output, 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
) -> Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>

Rebuild the original matrix.

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

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N, D> Debug for SymmetricEigen<N, D> where
    N: Debug + ComplexField,
    D: Debug + Dim,
    DefaultAllocator: Allocator<N, D, D>,
    DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
    <N as ComplexField>::RealField: Debug, 

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

Formats the value using the given formatter.

impl<'de, N, D> Deserialize<'de> for SymmetricEigen<N, D> where
    N: ComplexField,
    D: Dim,
    DefaultAllocator: Allocator<N, D, D>,
    DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
    DefaultAllocator: Allocator<N, D, D>,
    DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
    Matrix<<N as ComplexField>::RealField, D, U1, <DefaultAllocator as Allocator<<N as ComplexField>::RealField, D, U1>>::Buffer>: Deserialize<'de>,
    Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<N, D> Serialize for SymmetricEigen<N, D> where
    N: ComplexField,
    D: Dim,
    DefaultAllocator: Allocator<N, D, D>,
    DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
    DefaultAllocator: Allocator<N, D, D>,
    DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
    Matrix<<N as ComplexField>::RealField, D, U1, <DefaultAllocator as Allocator<<N as ComplexField>::RealField, D, U1>>::Buffer>: Serialize,
    Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>: Serialize, 

pub 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<N, D> Copy for SymmetricEigen<N, D> where
    N: ComplexField,
    D: Dim,
    DefaultAllocator: Allocator<N, D, D>,
    DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
    Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>: Copy,
    Matrix<<N as ComplexField>::RealField, D, U1, <DefaultAllocator as Allocator<<N as ComplexField>::RealField, D, U1>>::Buffer>: Copy,