Struct nalgebra::linalg::SymmetricEigen [−][src]
pub struct SymmetricEigen<T: ComplexField, D: Dim> where
DefaultAllocator: Allocator<T, D, D> + Allocator<T::RealField, D>, { pub eigenvectors: OMatrix<T, D, D>, pub eigenvalues: OVector<T::RealField, D>, }
Expand description
Eigendecomposition of a symmetric matrix.
Fields
eigenvectors: OMatrix<T, D, D>
The eigenvectors of the decomposed matrix.
eigenvalues: OVector<T::RealField, D>
The unsorted eigenvalues of the decomposed matrix.
Implementations
impl<T: ComplexField, D: Dim> SymmetricEigen<T, D> where
DefaultAllocator: Allocator<T, D, D> + Allocator<T::RealField, D>,
[src]
impl<T: ComplexField, D: Dim> SymmetricEigen<T, D> where
DefaultAllocator: Allocator<T, D, D> + Allocator<T::RealField, D>,
[src]pub fn new(m: OMatrix<T, D, D>) -> Self where
D: DimSub<U1>,
DefaultAllocator: Allocator<T, DimDiff<D, U1>> + Allocator<T::RealField, DimDiff<D, U1>>,
[src]
pub fn new(m: OMatrix<T, D, D>) -> Self where
D: DimSub<U1>,
DefaultAllocator: Allocator<T, DimDiff<D, U1>> + Allocator<T::RealField, DimDiff<D, 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: OMatrix<T, D, D>,
eps: T::RealField,
max_niter: usize
) -> Option<Self> where
D: DimSub<U1>,
DefaultAllocator: Allocator<T, DimDiff<D, U1>> + Allocator<T::RealField, DimDiff<D, U1>>,
[src]
pub fn try_new(
m: OMatrix<T, D, D>,
eps: T::RealField,
max_niter: usize
) -> Option<Self> where
D: DimSub<U1>,
DefaultAllocator: Allocator<T, DimDiff<D, U1>> + Allocator<T::RealField, DimDiff<D, 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. Ifniter == 0
, then the algorithm continues indefinitely until convergence.
Trait Implementations
impl<T: Clone + ComplexField, D: Clone + Dim> Clone for SymmetricEigen<T, D> where
DefaultAllocator: Allocator<T, D, D> + Allocator<T::RealField, D>,
T::RealField: Clone,
[src]
impl<T: Clone + ComplexField, D: Clone + Dim> Clone for SymmetricEigen<T, D> where
DefaultAllocator: Allocator<T, D, D> + Allocator<T::RealField, D>,
T::RealField: Clone,
[src]fn clone(&self) -> SymmetricEigen<T, D>
[src]
fn clone(&self) -> SymmetricEigen<T, D>
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl<T: Debug + ComplexField, D: Debug + Dim> Debug for SymmetricEigen<T, D> where
DefaultAllocator: Allocator<T, D, D> + Allocator<T::RealField, D>,
T::RealField: Debug,
[src]
impl<T: Debug + ComplexField, D: Debug + Dim> Debug for SymmetricEigen<T, D> where
DefaultAllocator: Allocator<T, D, D> + Allocator<T::RealField, D>,
T::RealField: Debug,
[src]impl<T: ComplexField, D: Dim> Copy for SymmetricEigen<T, D> where
DefaultAllocator: Allocator<T, D, D> + Allocator<T::RealField, D>,
OMatrix<T, D, D>: Copy,
OVector<T::RealField, D>: Copy,
[src]
DefaultAllocator: Allocator<T, D, D> + Allocator<T::RealField, D>,
OMatrix<T, D, D>: Copy,
OVector<T::RealField, D>: 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
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]pub fn to_subset(&self) -> Option<SS>
[src]
pub fn to_subset(&self) -> Option<SS>
[src]The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
[src]
pub fn is_in_subset(&self) -> bool
[src]Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
[src]
pub fn to_subset_unchecked(&self) -> SS
[src]Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
[src]
pub fn from_subset(element: &SS) -> SP
[src]The inclusion map: converts self
to the equivalent element of its superset.
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,