Struct ggez::graphics::na::SymmetricEigen

pub struct SymmetricEigen<N, D> where
    D: Dim,
    N: Real,
    DefaultAllocator: Allocator<N, D, D>,
    DefaultAllocator: Allocator<N, D, U1>,  {
    pub eigenvectors: Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>,
    pub eigenvalues: Matrix<N, D, U1, <DefaultAllocator as Allocator<N, 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, D, U1, <DefaultAllocator as Allocator<N, D, U1>>::Buffer>

The unsorted eigenvalues of the decomposed matrix.

Methods

impl<N, D> SymmetricEigen<N, D> where
    D: Dim,
    N: Real,
    DefaultAllocator: Allocator<N, D, D>,
    DefaultAllocator: Allocator<N, D, U1>, 

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>, 

Computes the eigendecomposition of the given symmetric matrix.

Only the lower-triangular parts (including its diagonal) of m is read.

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

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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.