Struct rin::math::SymmetricEigen[][src]

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>, 
[src]

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>, 
[src]

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>, 
[src]

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>
[src]

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
[src]

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
[src]

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>, 
[src]

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
[src]

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
[src]

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Any for T where
    T: Any
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Downcast for T where
    T: Any
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<V> IntoPnt<V> for V[src]

impl<V> IntoVec<V> for V[src]

impl<T> Pointable for T[src]

type Init = T

The type for initializers.

impl<T> Same<T> for T[src]

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, 
[src]

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 
[src]