Struct nalgebra::linalg::SymmetricEigen

source ·
pub struct SymmetricEigen<T: ComplexField, D: Dim>{
    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§

source§

impl<T: ComplexField, D: Dim> SymmetricEigen<T, D>

source

pub fn new(m: OMatrix<T, D, D>) -> Self

Computes the eigendecomposition of the given symmetric matrix.

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

source

pub fn try_new( m: OMatrix<T, D, D>, eps: T::RealField, max_niter: usize ) -> Option<Self>

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.
source

pub fn recompose(&self) -> OMatrix<T, D, D>

Rebuild the original matrix.

This is useful if some of the eigenvalues have been manually modified.

Trait Implementations§

source§

impl<T: Clone + ComplexField, D: Clone + Dim> Clone for SymmetricEigen<T, D>

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T: Debug + ComplexField, D: Debug + Dim> Debug for SymmetricEigen<T, D>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T: ComplexField, D: Dim> Copy for SymmetricEigen<T, D>
where DefaultAllocator: Allocator<D, D> + Allocator<D>, OMatrix<T, D, D>: Copy, OVector<T::RealField, D>: Copy,

Auto Trait Implementations§

§

impl<T, D> !Freeze for SymmetricEigen<T, D>

§

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§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
source§

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

The inclusion map: converts self to the equivalent element of its superset.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.