Struct bevy_rapier2d::prelude::nalgebra::linalg::SymmetricEigen

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

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_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>>::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>,
    DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>, 

pub fn new(
    m: Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>
) -> SymmetricEigen<T, D> where
    D: DimSub<Const<1_usize>>,
    DefaultAllocator: Allocator<T, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
    DefaultAllocator: Allocator<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>, 

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_usize>>,
    DefaultAllocator: Allocator<T, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
    DefaultAllocator: Allocator<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>, 

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>,
    DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
    <T as ComplexField>::RealField: Clone, 

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

Returns a copy 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<T, D, D>,
    DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
    <T as ComplexField>::RealField: Debug, 

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

Formats the value using the given formatter.

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