Struct nalgebra::linalg::SymmetricEigen
source · pub struct SymmetricEigen<N: Real, D: Dim>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, D>,{
pub eigenvectors: MatrixN<N, D>,
pub eigenvalues: VectorN<N, D>,
}
Expand description
Eigendecomposition of a symmetric matrix.
Fields§
§eigenvectors: MatrixN<N, D>
The eigenvectors of the decomposed matrix.
eigenvalues: VectorN<N, D>
The unsorted eigenvalues of the decomposed matrix.
Implementations§
source§impl<N: Real, D: Dim> SymmetricEigen<N, D>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, D>,
impl<N: Real, D: Dim> SymmetricEigen<N, D>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, D>,
sourcepub fn new(m: MatrixN<N, D>) -> Selfwhere
D: DimSub<U1>,
DefaultAllocator: Allocator<N, DimDiff<D, U1>>,
pub fn new(m: MatrixN<N, D>) -> Selfwhere
D: DimSub<U1>,
DefaultAllocator: Allocator<N, DimDiff<D, U1>>,
Computes the eigendecomposition of the given symmetric matrix.
Only the lower-triangular parts (including its diagonal) of m
is read.
sourcepub fn try_new(m: MatrixN<N, D>, eps: N, max_niter: usize) -> Option<Self>where
D: DimSub<U1>,
DefaultAllocator: Allocator<N, DimDiff<D, U1>>,
pub fn try_new(m: MatrixN<N, D>, eps: N, max_niter: usize) -> Option<Self>where
D: DimSub<U1>,
DefaultAllocator: Allocator<N, DimDiff<D, 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. Ifniter == 0
, then the algorithm continues indefinitely until convergence.
Trait Implementations§
source§impl<N: Clone + Real, D: Clone + Dim> Clone for SymmetricEigen<N, D>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, D>,
impl<N: Clone + Real, D: Clone + Dim> Clone for SymmetricEigen<N, D>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, D>,
source§fn clone(&self) -> SymmetricEigen<N, D>
fn clone(&self) -> SymmetricEigen<N, D>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<N: Debug + Real, D: Debug + Dim> Debug for SymmetricEigen<N, D>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, D>,
impl<N: Debug + Real, D: Debug + Dim> Debug for SymmetricEigen<N, D>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, D>,
impl<N: Real, D: Dim> Copy for SymmetricEigen<N, D>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, D>,
MatrixN<N, D>: Copy,
VectorN<N, D>: Copy,
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§
source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read moresource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).source§unsafe fn to_subset_unchecked(&self) -> SS
unsafe fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.