Struct rust_pathtracer::prelude::Schur

pub struct Schur<T, D>where
    T: ComplexField,
    D: Dim,
    DefaultAllocator: Allocator<T, D, D>,{ /* private fields */ }

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>>, DefaultAllocator: Allocator<T, D, <D as DimSub<Const<1>>>::Output> + Allocator<T, <D as DimSub<Const<1>>>::Output, Const<1>> + Allocator<T, D, D> + Allocator<T, D, Const<1>>,

pub fn new( 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>>

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<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>, <DefaultAllocator as Allocator<T, D, Const<1>>>::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>, <DefaultAllocator as Allocator<Complex<T>, D, Const<1>>>::Buffer>where T: RealField, DefaultAllocator: Allocator<Complex<T>, D, Const<1>>,

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>,

fn clone(&self) -> Schur<T, D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, D> Debug for Schur<T, D>where T: Debug + ComplexField, D: Debug + Dim, DefaultAllocator: Allocator<T, D, D>,

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

Formats the value using the given formatter.

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,