Struct nalgebra::linalg::Schur

source ·
pub struct Schur<T: ComplexField, D: Dim>{ /* private fields */ }
Expand description

Schur decomposition of a square matrix.

If this is a real matrix, this will be a RealField Schur decomposition.

Implementations§

source§

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

source

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

Computes the Schur decomposition of a square matrix.

source

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.
source

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().

source

pub fn eigenvalues(&self) -> Option<OVector<T, D>>

Computes the real eigenvalues of the decomposed matrix.

Return None if some eigenvalues are complex.

source

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

Computes the complex eigenvalues of the decomposed matrix.

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

impl<T: ComplexField, D: Dim> Copy for Schur<T, D>
where DefaultAllocator: Allocator<D, D>, OMatrix<T, D, D>: Copy,

Auto Trait Implementations§

§

impl<T, D> !Freeze for Schur<T, D>

§

impl<T, D> !RefUnwindSafe for Schur<T, D>

§

impl<T, D> !Send for Schur<T, D>

§

impl<T, D> !Sync for Schur<T, D>

§

impl<T, D> !Unpin for Schur<T, D>

§

impl<T, D> !UnwindSafe for Schur<T, D>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.