[−][src]Struct na::linalg::SymmetricEigen
Eigendecomposition of a symmetric matrix.
Fields
eigenvectors: Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>
The eigenvectors of the decomposed matrix.
eigenvalues: Matrix<<N as ComplexField>::RealField, D, U1, <DefaultAllocator as Allocator<<N as ComplexField>::RealField, D, U1>>::Buffer>
The unsorted eigenvalues of the decomposed matrix.
Methods
impl<N, D> SymmetricEigen<N, D> where
D: Dim,
N: ComplexField,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
[src]
D: Dim,
N: ComplexField,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
pub fn new(
m: Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>
) -> SymmetricEigen<N, D> where
D: DimSub<U1>,
DefaultAllocator: Allocator<N, <D as DimSub<U1>>::Output, U1>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, <D as DimSub<U1>>::Output, U1>,
[src]
m: Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>
) -> SymmetricEigen<N, D> where
D: DimSub<U1>,
DefaultAllocator: Allocator<N, <D as DimSub<U1>>::Output, U1>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, <D as DimSub<U1>>::Output, U1>,
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<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>,
eps: <N as ComplexField>::RealField,
max_niter: usize
) -> Option<SymmetricEigen<N, D>> where
D: DimSub<U1>,
DefaultAllocator: Allocator<N, <D as DimSub<U1>>::Output, U1>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, <D as DimSub<U1>>::Output, U1>,
[src]
m: Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>,
eps: <N as ComplexField>::RealField,
max_niter: usize
) -> Option<SymmetricEigen<N, D>> where
D: DimSub<U1>,
DefaultAllocator: Allocator<N, <D as DimSub<U1>>::Output, U1>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, <D as DimSub<U1>>::Output, 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.
pub fn recompose(
&self
) -> Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>
[src]
&self
) -> Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>
Rebuild the original matrix.
This is useful if some of the eigenvalues have been manually modified.
Trait Implementations
impl<N, D> Clone for SymmetricEigen<N, D> where
D: Dim + Clone,
N: Clone + ComplexField,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
<N as ComplexField>::RealField: Clone,
[src]
D: Dim + Clone,
N: Clone + ComplexField,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
<N as ComplexField>::RealField: Clone,
fn clone(&self) -> SymmetricEigen<N, D>
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl<N, D> Copy for SymmetricEigen<N, D> where
D: Dim,
N: ComplexField,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>: Copy,
Matrix<<N as ComplexField>::RealField, D, U1, <DefaultAllocator as Allocator<<N as ComplexField>::RealField, D, U1>>::Buffer>: Copy,
[src]
D: Dim,
N: ComplexField,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>: Copy,
Matrix<<N as ComplexField>::RealField, D, U1, <DefaultAllocator as Allocator<<N as ComplexField>::RealField, D, U1>>::Buffer>: Copy,
impl<N, D> Debug for SymmetricEigen<N, D> where
D: Dim + Debug,
N: Debug + ComplexField,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
<N as ComplexField>::RealField: Debug,
[src]
D: Dim + Debug,
N: Debug + ComplexField,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
<N as ComplexField>::RealField: Debug,
Auto Trait Implementations
impl<N, D> !Send for SymmetricEigen<N, D>
impl<N, D> !Sync for SymmetricEigen<N, D>
Blanket Implementations
impl<V> IntoVec<V> for V
[src]
impl<V> IntoPnt<V> for V
[src]
impl<T> From<T> for T
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]
SS: SubsetOf<SP>,