Struct lnkit::prelude::SymmetricEigen [−][src]
pub struct SymmetricEigen<T, D> where
T: ComplexField,
D: Dim,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>, { pub eigenvectors: Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>, pub eigenvalues: Matrix<<T as ComplexField>::RealField, D, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>>::Buffer>, }
Eigendecomposition of a symmetric matrix.
Fields
eigenvectors: Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>
The eigenvectors of the decomposed matrix.
eigenvalues: Matrix<<T as ComplexField>::RealField, D, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>>::Buffer>
The unsorted eigenvalues of the decomposed matrix.
Implementations
impl<T, D> SymmetricEigen<T, D> where
T: ComplexField,
D: Dim,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
[src]
impl<T, D> SymmetricEigen<T, D> where
T: ComplexField,
D: Dim,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
[src]pub fn new(
m: Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>
) -> SymmetricEigen<T, D> where
D: DimSub<Const<1_usize>>,
DefaultAllocator: Allocator<T, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
[src]
m: Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>
) -> SymmetricEigen<T, D> where
D: DimSub<Const<1_usize>>,
DefaultAllocator: Allocator<T, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
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<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>,
eps: <T as ComplexField>::RealField,
max_niter: usize
) -> Option<SymmetricEigen<T, D>> where
D: DimSub<Const<1_usize>>,
DefaultAllocator: Allocator<T, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
[src]
m: Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>,
eps: <T as ComplexField>::RealField,
max_niter: usize
) -> Option<SymmetricEigen<T, D>> where
D: DimSub<Const<1_usize>>,
DefaultAllocator: Allocator<T, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
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<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>
[src]
&self
) -> Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>
Rebuild the original matrix.
This is useful if some of the eigenvalues have been manually modified.
Trait Implementations
impl<T, D> Clone for SymmetricEigen<T, D> where
T: Clone + ComplexField,
D: Clone + Dim,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
<T as ComplexField>::RealField: Clone,
[src]
impl<T, D> Clone for SymmetricEigen<T, D> where
T: Clone + ComplexField,
D: Clone + Dim,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
<T as ComplexField>::RealField: Clone,
[src]pub fn clone(&self) -> SymmetricEigen<T, D>
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<T, D> Copy for SymmetricEigen<T, D> where
T: ComplexField,
D: Dim,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>: Copy,
Matrix<<T as ComplexField>::RealField, D, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>>::Buffer>: Copy,
[src]
impl<T, D> Copy for SymmetricEigen<T, D> where
T: ComplexField,
D: Dim,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>: Copy,
Matrix<<T as ComplexField>::RealField, D, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>>::Buffer>: Copy,
[src]impl<T, D> Debug for SymmetricEigen<T, D> where
T: Debug + ComplexField,
D: Debug + Dim,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
<T as ComplexField>::RealField: Debug,
[src]
impl<T, D> Debug for SymmetricEigen<T, D> where
T: Debug + ComplexField,
D: Debug + Dim,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
<T as ComplexField>::RealField: Debug,
[src]impl<'de, T, D> Deserialize<'de> for SymmetricEigen<T, D> where
T: ComplexField,
D: Dim,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
Matrix<<T as ComplexField>::RealField, D, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>>::Buffer>: Deserialize<'de>,
Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>: Deserialize<'de>,
[src]
impl<'de, T, D> Deserialize<'de> for SymmetricEigen<T, D> where
T: ComplexField,
D: Dim,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
Matrix<<T as ComplexField>::RealField, D, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>>::Buffer>: Deserialize<'de>,
Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>: Deserialize<'de>,
[src]pub fn deserialize<__D>(
__deserializer: __D
) -> Result<SymmetricEigen<T, D>, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
[src]
__deserializer: __D
) -> Result<SymmetricEigen<T, D>, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
impl<T, D> Serialize for SymmetricEigen<T, D> where
T: ComplexField,
D: Dim,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
Matrix<<T as ComplexField>::RealField, D, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>>::Buffer>: Serialize,
Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>: Serialize,
[src]
impl<T, D> Serialize for SymmetricEigen<T, D> where
T: ComplexField,
D: Dim,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>,
Matrix<<T as ComplexField>::RealField, D, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, D, Const<1_usize>>>::Buffer>: Serialize,
Matrix<T, D, D, <DefaultAllocator as Allocator<T, 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,
Auto Trait Implementations
impl<T, D> !RefUnwindSafe for SymmetricEigen<T, D>
impl<T, D> !RefUnwindSafe for SymmetricEigen<T, D>
impl<T, D> !Send for SymmetricEigen<T, D>
impl<T, D> !Send for SymmetricEigen<T, D>
impl<T, D> !Sync for SymmetricEigen<T, D>
impl<T, D> !Sync for SymmetricEigen<T, D>
impl<T, D> !Unpin for SymmetricEigen<T, D>
impl<T, D> !Unpin for SymmetricEigen<T, D>
impl<T, D> !UnwindSafe for SymmetricEigen<T, D>
impl<T, D> !UnwindSafe for SymmetricEigen<T, D>
Blanket Implementations
impl<T, U> Cast<U> for T where
U: FromCast<T>,
impl<T, U> Cast<U> for T where
U: FromCast<T>,
pub fn cast(self) -> U
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
impl<T> FromBits<T> for T
impl<T> FromBits<T> for T
pub fn from_bits(t: T) -> T
impl<T> FromCast<T> for T
impl<T> FromCast<T> for T
pub fn from_cast(t: T) -> T
impl<T, U> IntoBits<U> for T where
U: FromBits<T>,
impl<T, U> IntoBits<U> for T where
U: FromBits<T>,
pub fn into_bits(self) -> U
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
pub fn to_subset(&self) -> Option<SS>
pub fn is_in_subset(&self) -> bool
pub fn to_subset_unchecked(&self) -> SS
pub fn from_subset(element: &SS) -> SP
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,