Struct rin::math::linalg::RealSchur

pub struct RealSchur<N, D> where
    D: Dim,
    N: Real,
    DefaultAllocator: Allocator<N, D, D>,  { /* fields omitted */ }

Real Schur decomposition of a square matrix.

Methods

impl<N, D> RealSchur<N, D> where     D: Dim + DimSub<U1>,     N: Real,     ShapeConstraint: DimEq<Dynamic, <D as DimSub<U1>>::Output>,     DefaultAllocator: Allocator<N, D, <D as DimSub<U1>>::Output>,     DefaultAllocator: Allocator<N, <D as DimSub<U1>>::Output, U1>,     DefaultAllocator: Allocator<N, D, D>,     DefaultAllocator: Allocator<N, D, U1>,

pub fn new(     m: Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer> ) -> RealSchur<N, D>

Computes the Schur decomposition of a square matrix.

pub fn try_new(     m: Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>,     eps: N,     max_niter: usize ) -> Option<RealSchur<N, 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. If niter == 0, then the algorithm continues indefinitely until convergence.

pub fn unpack(     self ) -> (Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>, Matrix<N, D, D, <DefaultAllocator as Allocator<N, 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<N, D, U1, <DefaultAllocator as Allocator<N, D, U1>>::Buffer>>

Computes the real eigenvalues of the decomposed matrix.

Return None if some eigenvalues are complex.

pub fn complex_eigenvalues(     &self ) -> Matrix<Complex<N>, D, U1, <DefaultAllocator as Allocator<Complex<N>, D, U1>>::Buffer> where     DefaultAllocator: Allocator<Complex<N>, D, U1>,

Computes the complex eigenvalues of the decomposed matrix.

Trait Implementations

impl<N, D> Copy for RealSchur<N, D> where     D: Dim,     N: Real,     DefaultAllocator: Allocator<N, D, D>,     Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>: Copy,

impl<N, D> Clone for RealSchur<N, D> where     D: Dim + Clone,     N: Clone + Real,     DefaultAllocator: Allocator<N, D, D>,

fn clone(&self) -> RealSchur<N, D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N, D> Debug for RealSchur<N, D> where     D: Dim + Debug,     N: Debug + Real,     DefaultAllocator: Allocator<N, D, D>,

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

Formats the value using the given formatter.

impl<'de, N, D> Deserialize<'de> for RealSchur<N, D> where     D: Dim,     N: Real,     DefaultAllocator: Allocator<N, D, D>,     DefaultAllocator: Allocator<N, D, D>,     Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>: Deserialize<'de>,

fn deserialize<__D>(     __deserializer: __D ) -> Result<RealSchur<N, D>, <__D as Deserializer<'de>>::Error> where     __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<N, D> Serialize for RealSchur<N, D> where     D: Dim,     N: Real,     DefaultAllocator: Allocator<N, D, D>,     DefaultAllocator: Allocator<N, D, D>,     Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>: Serialize,

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

Serialize this value into the given Serde serializer.