Struct heron::rapier_plugin::rapier2d::prelude::nalgebra::SymmetricEigen [−][src]
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>,
}
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_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>>,
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>>,
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>>,
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. Ifniter == 0
, then the algorithm continues indefinitely until convergence.
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,
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,
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,
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,
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,
Auto Trait Implementations
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
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
impl<T> Pointable for T
impl<T> Pointable for T
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more