Struct nalgebra::linalg::RealSchur
[−]
[src]
pub struct RealSchur<N: Real, D: Dim> where
DefaultAllocator: Allocator<N, D, D>, { /* fields omitted */ }
Real Schur decomposition of a square matrix.
Methods
impl<N: Real, D: Dim> RealSchur<N, D> where
D: DimSub<U1>,
ShapeConstraint: DimEq<Dynamic, DimDiff<D, U1>>,
DefaultAllocator: Allocator<N, D, DimDiff<D, U1>> + Allocator<N, DimDiff<D, U1>> + Allocator<N, D, D> + Allocator<N, D>,
[src]
D: DimSub<U1>,
ShapeConstraint: DimEq<Dynamic, DimDiff<D, U1>>,
DefaultAllocator: Allocator<N, D, DimDiff<D, U1>> + Allocator<N, DimDiff<D, U1>> + Allocator<N, D, D> + Allocator<N, D>,
pub fn new(m: MatrixN<N, D>) -> RealSchur<N, D>
[src]
Computes the Schur decomposition of a square matrix.
pub fn try_new(
m: MatrixN<N, D>,
eps: N,
max_niter: usize
) -> Option<RealSchur<N, D>>
[src]
m: MatrixN<N, D>,
eps: N,
max_niter: usize
) -> Option<RealSchur<N, 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
− tolerence 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) -> (MatrixN<N, D>, MatrixN<N, 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<VectorN<N, D>>
[src]
Computes the real eigenvalues of the decomposed matrix.
Return None
if some eigenvalues are complex.
pub fn complex_eigenvalues(&self) -> VectorN<Complex<N>, D> where
DefaultAllocator: Allocator<Complex<N>, D>,
[src]
DefaultAllocator: Allocator<Complex<N>, D>,
Computes the complex eigenvalues of the decomposed matrix.
Trait Implementations
impl<N: Clone + Real, D: Clone + Dim> Clone for RealSchur<N, D> where
DefaultAllocator: Allocator<N, D, D>,
[src]
DefaultAllocator: Allocator<N, D, D>,
fn clone(&self) -> RealSchur<N, D>
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl<N: Debug + Real, D: Debug + Dim> Debug for RealSchur<N, D> where
DefaultAllocator: Allocator<N, D, D>,
[src]
DefaultAllocator: Allocator<N, D, D>,
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl<N: Real, D: Dim> Copy for RealSchur<N, D> where
DefaultAllocator: Allocator<N, D, D>,
MatrixN<N, D>: Copy,
[src]
DefaultAllocator: Allocator<N, D, D>,
MatrixN<N, D>: Copy,