Struct lnkit::prelude::linalg::Schur [−][src]
pub struct Schur<T, D> where
T: ComplexField,
D: Dim,
DefaultAllocator: Allocator<T, D, D>, { /* fields omitted */ }
Schur decomposition of a square matrix.
If this is a real matrix, this will be a RealField Schur decomposition.
Implementations
impl<T, D> Schur<T, D> where
T: ComplexField,
D: Dim + DimSub<Const<1_usize>>,
DefaultAllocator: Allocator<T, D, <D as DimSub<Const<1_usize>>>::Output>,
DefaultAllocator: Allocator<T, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<T, D, Const<1_usize>>,
[src]
impl<T, D> Schur<T, D> where
T: ComplexField,
D: Dim + DimSub<Const<1_usize>>,
DefaultAllocator: Allocator<T, D, <D as DimSub<Const<1_usize>>>::Output>,
DefaultAllocator: Allocator<T, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<T, D, Const<1_usize>>,
[src]pub fn new(
m: Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>
) -> Schur<T, D>
[src]
m: Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>
) -> Schur<T, D>
Computes the Schur decomposition of a square matrix.
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<Schur<T, D>>
[src]
m: Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>,
eps: <T as ComplexField>::RealField,
max_niter: usize
) -> Option<Schur<T, D>>
Attempts to compute the Schur decomposition of a square matrix.
If only eigenvalues are needed, it is more efficient to call the matrix method
.eigenvalues()
instead.
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 unpack(
self
) -> (Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>, Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>)
[src]
self
) -> (Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>, Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>)
Retrieves the unitary matrix Q
and the upper-quasitriangular matrix T
such that the
decomposed matrix equals Q * T * Q.transpose()
.
pub fn eigenvalues(
&self
) -> Option<Matrix<T, D, Const<1_usize>, <DefaultAllocator as Allocator<T, D, Const<1_usize>>>::Buffer>>
[src]
&self
) -> Option<Matrix<T, D, Const<1_usize>, <DefaultAllocator as Allocator<T, D, Const<1_usize>>>::Buffer>>
Computes the real eigenvalues of the decomposed matrix.
Return None
if some eigenvalues are complex.
pub fn complex_eigenvalues(
&self
) -> Matrix<Complex<T>, D, Const<1_usize>, <DefaultAllocator as Allocator<Complex<T>, D, Const<1_usize>>>::Buffer> where
T: RealField,
DefaultAllocator: Allocator<Complex<T>, D, Const<1_usize>>,
[src]
&self
) -> Matrix<Complex<T>, D, Const<1_usize>, <DefaultAllocator as Allocator<Complex<T>, D, Const<1_usize>>>::Buffer> where
T: RealField,
DefaultAllocator: Allocator<Complex<T>, D, Const<1_usize>>,
Computes the complex eigenvalues of the decomposed matrix.
Trait Implementations
impl<T, D> Clone for Schur<T, D> where
T: Clone + ComplexField,
D: Clone + Dim,
DefaultAllocator: Allocator<T, D, D>,
[src]
impl<T, D> Clone for Schur<T, D> where
T: Clone + ComplexField,
D: Clone + Dim,
DefaultAllocator: Allocator<T, D, D>,
[src]impl<T, D> Copy for Schur<T, D> where
T: ComplexField,
D: Dim,
DefaultAllocator: Allocator<T, D, D>,
Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>: Copy,
[src]
impl<T, D> Copy for Schur<T, D> where
T: ComplexField,
D: Dim,
DefaultAllocator: Allocator<T, D, D>,
Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>: Copy,
[src]impl<T, D> Debug for Schur<T, D> where
T: Debug + ComplexField,
D: Debug + Dim,
DefaultAllocator: Allocator<T, D, D>,
[src]
impl<T, D> Debug for Schur<T, D> where
T: Debug + ComplexField,
D: Debug + Dim,
DefaultAllocator: Allocator<T, D, D>,
[src]impl<'de, T, D> Deserialize<'de> for Schur<T, D> where
T: ComplexField,
D: Dim,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<T, D, D>,
Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>: Deserialize<'de>,
[src]
impl<'de, T, D> Deserialize<'de> for Schur<T, D> where
T: ComplexField,
D: Dim,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<T, D, D>,
Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>: Deserialize<'de>,
[src]pub fn deserialize<__D>(
__deserializer: __D
) -> Result<Schur<T, D>, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
[src]
__deserializer: __D
) -> Result<Schur<T, D>, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
impl<T, D> Serialize for Schur<T, D> where
T: ComplexField,
D: Dim,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<T, D, D>,
Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>: Serialize,
[src]
impl<T, D> Serialize for Schur<T, D> where
T: ComplexField,
D: Dim,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<T, D, D>,
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 Schur<T, D>
impl<T, D> !RefUnwindSafe for Schur<T, D>
impl<T, D> !UnwindSafe for Schur<T, D>
impl<T, D> !UnwindSafe for Schur<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>,