Struct nalgebra::linalg::SymmetricEigen

source ·

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

source

impl<T: ComplexField, D: Dim> SymmetricEigen<T, D>where
DefaultAllocator: Allocator<T, D, D> + Allocator<T::RealField, D>,

source

pub fn new(m: OMatrix<T, D, D>) -> Selfwhere
D: DimSub<U1>,
DefaultAllocator: Allocator<T, DimDiff<D, U1>> + Allocator<T::RealField, DimDiff<D, U1>>,

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>where
 D: DimSub<U1>,
 DefaultAllocator: Allocator<T, DimDiff<D, U1>> + Allocator<T::RealField, 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. 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>where
DefaultAllocator: Allocator<T, D, D> + Allocator<T::RealField, D>,
T::RealField: Clone,

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>where
DefaultAllocator: Allocator<T, D, D> + Allocator<T::RealField, D>,
T::RealField: Debug,

source

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

Formats the value using the given formatter. Read more

source

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

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

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

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

source

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,

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

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.

source

fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere
 W: DeserializeWith<F, T, D>,
 D: Fallible + ?Sized,
 F: ?Sized,

source

fn deserialize(
&self,
deserializer: &mut D
) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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> LayoutRaw for T

source

fn layout_raw(_: *const T) -> Layout

Gets the layout of the type.

impl<T> Pointee for T

type Metadata = ()

The type for metadata in pointers and references to Self.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<SS, SP> SupersetOf<SS> for SPwhere
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<SS, SP> SupersetOf<SS> for SPwhere
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

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

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

source

impl<T> ToOwned for Twhere
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 for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct nalgebra::linalg::SymmetricEigen

Fields

Implementations

impl<T: ComplexField, D: Dim> SymmetricEigen<T, D>where DefaultAllocator: Allocator<T, D, D> + Allocator<T::RealField, D>,

pub fn new(m: OMatrix<T, D, D>) -> Selfwhere D: DimSub<U1>, DefaultAllocator: Allocator<T, DimDiff<D, U1>> + Allocator<T::RealField, DimDiff<D, U1>>,

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>>,

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

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,

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

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

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,

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

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

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,

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> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata

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

fn borrow(&self) -> &T

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

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

impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

fn deserialize( &self, deserializer: &mut D) -> Result<With<T, W>, <D as Fallible>::Error>

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> LayoutRaw for T

fn layout_raw(_: *const T) -> Layout

impl<T> Pointee for T

type Metadata = ()

impl<T> Same<T> for T

type Output = T

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

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

fn is_in_subset(&self) -> bool

fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

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

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

fn is_in_subset(&self) -> bool

unsafe fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

impl<T: ComplexField, D: Dim> SymmetricEigen<T, D>where
DefaultAllocator: Allocator<T, D, D> + Allocator<T::RealField, D>,

pub fn new(m: OMatrix<T, D, D>) -> Selfwhere
D: DimSub<U1>,
DefaultAllocator: Allocator<T, DimDiff<D, U1>> + Allocator<T::RealField, DimDiff<D, U1>>,

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>>,

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,

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,

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
__D: Deserializer<'de>,

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
S: Serializer,

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,

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

fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata

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

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

impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,

fn deserialize(
&self,
deserializer: &mut D
) -> Result<With<T, W>, <D as Fallible>::Error>

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

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

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

impl<T> ToOwned for Twhere
T: Clone,

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

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

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,