Struct nalgebra::linalg::Schur [−][src]
pub struct Schur<T: ComplexField, D: Dim> where
DefaultAllocator: Allocator<T, D, D>, { /* fields omitted */ }
Expand description
Schur decomposition of a square matrix.
If this is a real matrix, this will be a RealField Schur decomposition.
Implementations
impl<T: ComplexField, D: Dim> Schur<T, D> where
D: DimSub<U1>,
DefaultAllocator: Allocator<T, D, DimDiff<D, U1>> + Allocator<T, DimDiff<D, U1>> + Allocator<T, D, D> + Allocator<T, D>,
[src]
impl<T: ComplexField, D: Dim> Schur<T, D> where
D: DimSub<U1>,
DefaultAllocator: Allocator<T, D, DimDiff<D, U1>> + Allocator<T, DimDiff<D, U1>> + Allocator<T, D, D> + Allocator<T, D>,
[src]pub fn try_new(
m: OMatrix<T, D, D>,
eps: T::RealField,
max_niter: usize
) -> Option<Self>
[src]
pub fn try_new(
m: OMatrix<T, D, D>,
eps: T::RealField,
max_niter: usize
) -> Option<Self>
[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. Ifniter == 0
, then the algorithm continues indefinitely until convergence.
pub fn unpack(self) -> (OMatrix<T, D, D>, OMatrix<T, D, D>)
[src]
pub fn unpack(self) -> (OMatrix<T, D, D>, OMatrix<T, D, D>)
[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<OVector<T, D>>
[src]
pub fn eigenvalues(&self) -> Option<OVector<T, D>>
[src]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>,
[src]
pub fn complex_eigenvalues(&self) -> OVector<NumComplex<T>, D> where
T: RealField,
DefaultAllocator: Allocator<NumComplex<T>, D>,
[src]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>,
[src]
impl<T: Clone + ComplexField, D: Clone + Dim> Clone for Schur<T, D> where
DefaultAllocator: Allocator<T, D, D>,
[src]impl<T: Debug + ComplexField, D: Debug + Dim> Debug for Schur<T, D> where
DefaultAllocator: Allocator<T, D, D>,
[src]
impl<T: Debug + ComplexField, D: Debug + Dim> Debug for Schur<T, D> where
DefaultAllocator: Allocator<T, D, D>,
[src]impl<T: ComplexField, D: Dim> Copy for Schur<T, D> where
DefaultAllocator: Allocator<T, D, D>,
OMatrix<T, D, D>: Copy,
[src]
DefaultAllocator: Allocator<T, D, D>,
OMatrix<T, D, D>: 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> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]pub fn to_subset(&self) -> Option<SS>
[src]
pub fn to_subset(&self) -> Option<SS>
[src]The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
[src]
pub fn is_in_subset(&self) -> bool
[src]Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
[src]
pub fn to_subset_unchecked(&self) -> SS
[src]Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
[src]
pub fn from_subset(element: &SS) -> SP
[src]The inclusion map: converts self
to the equivalent element of its superset.
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,