Struct rin::math::linalg::Schur[][src]

pub struct Schur<N, D> where
    N: ComplexField,
    D: Dim,
    DefaultAllocator: Allocator<N, 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<N, D> Schur<N, D> where
    N: ComplexField,
    D: Dim + DimSub<U1>,
    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>, 
[src]

pub fn new(
    m: Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>
) -> Schur<N, D>
[src]

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 as ComplexField>::RealField,
    max_niter: usize
) -> Option<Schur<N, D>>
[src]

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>)
[src]

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>>
[src]

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
    N: RealField,
    DefaultAllocator: Allocator<Complex<N>, D, U1>, 
[src]

Computes the complex eigenvalues of the decomposed matrix.

Trait Implementations

impl<N, D> Clone for Schur<N, D> where
    N: Clone + ComplexField,
    D: Clone + Dim,
    DefaultAllocator: Allocator<N, D, D>, 
[src]

impl<N, D> Debug for Schur<N, D> where
    N: Debug + ComplexField,
    D: Debug + Dim,
    DefaultAllocator: Allocator<N, D, D>, 
[src]

impl<'de, N, D> Deserialize<'de> for Schur<N, D> where
    N: ComplexField,
    D: Dim,
    DefaultAllocator: Allocator<N, D, D>,
    DefaultAllocator: Allocator<N, D, D>,
    Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>: Deserialize<'de>, 
[src]

impl<N, D> Serialize for Schur<N, D> where
    N: ComplexField,
    D: Dim,
    DefaultAllocator: Allocator<N, D, D>,
    DefaultAllocator: Allocator<N, D, D>,
    Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>: Serialize
[src]

impl<N, D> Copy for Schur<N, D> where
    N: ComplexField,
    D: Dim,
    DefaultAllocator: Allocator<N, D, D>,
    Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>: Copy
[src]

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Any for T where
    T: Any
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Downcast for T where
    T: Any
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<V> IntoPnt<V> for V[src]

impl<V> IntoVec<V> for V[src]

impl<T> Pointable for T[src]

type Init = T

The type for initializers.

impl<T> Same<T> for T[src]

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, 
[src]

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 
[src]