Struct nalgebra::linalg::Schur

pub struct Schur<T: ComplexField, D: Dim>
where
    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: ComplexField, D> Schur<T, D>

where D: DimSub<U1> + Dim, DefaultAllocator: Allocator<T, D, DimDiff<D, U1>> + Allocator<T, DimDiff<D, U1>> + Allocator<T, D, D> + Allocator<T, D>,

pub fn new(m: OMatrix<T, D, D>) -> Self

Computes the Schur decomposition of a square matrix.

pub fn try_new( m: OMatrix<T, D, D>, eps: T::RealField, max_niter: usize ) -> Option<Self>

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) -> (OMatrix<T, D, D>, OMatrix<T, D, D>)

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<OVector<T, D>>

Computes the real eigenvalues of the decomposed matrix.

Return None if some eigenvalues are complex.

pub fn complex_eigenvalues(&self) -> OVector<NumComplex<T>, D>

where T: RealField, DefaultAllocator: Allocator<NumComplex<T>, D>,

Computes the complex eigenvalues of the decomposed matrix.

Trait Implementations

impl<T: Clone + ComplexField, D: Clone + Dim> Clone for Schur<T, D>

where 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: Debug + ComplexField, D: Debug + Dim> Debug for Schur<T, D>

where DefaultAllocator: Allocator<T, D, D>,

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

Formats the value using the given formatter.

impl<'de, T: ComplexField, D: Dim> Deserialize<'de> for Schur<T, D>

where DefaultAllocator: Allocator<T, D, D>, OMatrix<T, D, D>: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: ComplexField, D: Dim> Serialize for Schur<T, D>

where DefaultAllocator: Allocator<T, D, D>, OMatrix<T, D, D>: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: ComplexField, D: Dim> Copy for Schur<T, D>

where DefaultAllocator: Allocator<T, D, D>, OMatrix<T, D, D>: Copy,