Struct na::SymmetricEigen [−][src]
pub struct SymmetricEigen<N, D> where
D: Dim,
N: ComplexField,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>, { pub eigenvectors: Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>, pub eigenvalues: Matrix<<N as ComplexField>::RealField, D, U1, <DefaultAllocator as Allocator<<N as ComplexField>::RealField, D, U1>>::Buffer>, }
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.
Implementations
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]
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]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: Clone + Dim,
N: Clone + ComplexField,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
<N as ComplexField>::RealField: Clone,
[src]
impl<N, D> Clone for SymmetricEigen<N, D> where
D: Clone + Dim,
N: Clone + ComplexField,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
<N as ComplexField>::RealField: Clone,
[src]pub fn clone(&self) -> SymmetricEigen<N, D>
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<N, D> Debug for SymmetricEigen<N, D> where
D: Debug + Dim,
N: Debug + ComplexField,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
<N as ComplexField>::RealField: Debug,
[src]
impl<N, D> Debug for SymmetricEigen<N, D> where
D: Debug + Dim,
N: Debug + ComplexField,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
<N as ComplexField>::RealField: Debug,
[src]impl<'de, N, D> Deserialize<'de> for SymmetricEigen<N, D> where
D: Dim,
N: ComplexField,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
Matrix<<N as ComplexField>::RealField, D, U1, <DefaultAllocator as Allocator<<N as ComplexField>::RealField, D, U1>>::Buffer>: Deserialize<'de>,
Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>: Deserialize<'de>,
[src]
impl<'de, N, D> Deserialize<'de> for SymmetricEigen<N, D> where
D: Dim,
N: ComplexField,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
Matrix<<N as ComplexField>::RealField, D, U1, <DefaultAllocator as Allocator<<N as ComplexField>::RealField, D, U1>>::Buffer>: Deserialize<'de>,
Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>: Deserialize<'de>,
[src]pub fn deserialize<__D>(
__deserializer: __D
) -> Result<SymmetricEigen<N, D>, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
[src]
__deserializer: __D
) -> Result<SymmetricEigen<N, D>, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
impl<N, D> Serialize for SymmetricEigen<N, D> where
D: Dim,
N: ComplexField,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
Matrix<<N as ComplexField>::RealField, D, U1, <DefaultAllocator as Allocator<<N as ComplexField>::RealField, D, U1>>::Buffer>: Serialize,
Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>: Serialize,
[src]
impl<N, D> Serialize for SymmetricEigen<N, D> where
D: Dim,
N: ComplexField,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
DefaultAllocator: Allocator<N, D, D>,
DefaultAllocator: Allocator<<N as ComplexField>::RealField, D, U1>,
Matrix<<N as ComplexField>::RealField, D, U1, <DefaultAllocator as Allocator<<N as ComplexField>::RealField, D, U1>>::Buffer>: Serialize,
Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>: Serialize,
[src]pub fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
[src]
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
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,
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
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]