Struct na::Schur

source · [−]

pub struct Schur<T, D> where
    T: ComplexField,
    D: Dim,
    DefaultAllocator: Allocator<T, D, D>,  { /* 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, D> Schur<T, D> where
 T: ComplexField,
 D: Dim + DimSub<Const<1_usize>>,
 DefaultAllocator: Allocator<T, D, <D as DimSub<Const<1_usize>>>::Output>,
 DefaultAllocator: Allocator<T, <D as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
 DefaultAllocator: Allocator<T, D, D>,
 DefaultAllocator: Allocator<T, D, Const<1_usize>>,

source

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.

source

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.

source

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

source

pub fn eigenvalues(
&self
) -> Option<Matrix<T, D, Const<1_usize>, <DefaultAllocator as Allocator<T, D, Const<1_usize>>>::Buffer>>

Computes the real eigenvalues of the decomposed matrix.

Return None if some eigenvalues are complex.

source

pub fn complex_eigenvalues(
 &self
) -> Matrix<Complex<T>, D, Const<1_usize>, <DefaultAllocator as Allocator<Complex<T>, D, Const<1_usize>>>::Buffer> where
 T: RealField,
 DefaultAllocator: Allocator<Complex<T>, D, Const<1_usize>>,

Computes the complex eigenvalues of the decomposed matrix.

Trait Implementations

source

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

source

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

Formats the value using the given formatter. Read more

source

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,

Auto Trait Implementations

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>

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<T> 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)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct na::Schur

Implementations

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

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

Arguments

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

pub fn eigenvalues( &self) -> Option<Matrix<T, D, Const<1_usize>, <DefaultAllocator as Allocator<T, D, Const<1_usize>>>::Buffer>>

pub fn complex_eigenvalues( &self) -> Matrix<Complex<T>, D, Const<1_usize>, <DefaultAllocator as Allocator<Complex<T>, D, Const<1_usize>>>::Buffer> where T: RealField, DefaultAllocator: Allocator<Complex<T>, D, Const<1_usize>>,

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>

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

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>

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,

Auto Trait Implementations

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

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<V> IntoPnt<V> for V

fn into_pnt(self) -> V

impl<V> IntoVec<V> for V

fn into_vec(self) -> V

impl<T> Same<T> for T

type Output = T

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

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

fn is_in_subset(&self) -> bool

fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

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

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

pub fn eigenvalues(
&self
) -> Option<Matrix<T, D, Const<1_usize>, <DefaultAllocator as Allocator<T, D, Const<1_usize>>>::Buffer>>

pub fn complex_eigenvalues(
&self
) -> Matrix<Complex<T>, D, Const<1_usize>, <DefaultAllocator as Allocator<Complex<T>, D, Const<1_usize>>>::Buffer> where
T: RealField,
DefaultAllocator: Allocator<Complex<T>, D, Const<1_usize>>,

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

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

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,

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

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

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

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

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

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

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

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