SymmetricEigen

noises_and_patterns::prelude

Struct SymmetricEigen

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

Expand description

Eigendecomposition of a symmetric matrix.

Fields§

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

The eigenvectors of the decomposed matrix.

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

The unsorted eigenvalues of the decomposed matrix.

Implementations§

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

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

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<T, D, D> + Allocator<<T as ComplexField>::RealField, D>, <T as ComplexField>::RealField: Clone,

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

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

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

Auto Trait Implementations§

impl<T, D> !Freeze for SymmetricEigen<T, D>

impl<T, D> !RefUnwindSafe for SymmetricEigen<T, D>

impl<T, D> !Send for SymmetricEigen<T, D>

impl<T, D> !Sync for SymmetricEigen<T, D>

impl<T, D> !Unpin for SymmetricEigen<T, D>

impl<T, D> !UnwindSafe for SymmetricEigen<T, D>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.