Struct nalgebra::linalg::Hessenberg

pub struct Hessenberg<N: Real, D: DimSub<U1>>where
    DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,{ /* private fields */ }

Hessenberg decomposition of a general matrix.

Implementations

impl<N: Real, D: DimSub<U1>> Hessenberg<N, D>where
    DefaultAllocator: Allocator<N, D, D> + Allocator<N, D> + Allocator<N, DimDiff<D, U1>>,

pub fn new(hess: MatrixN<N, D>) -> Self

Computes the Hessenberg decomposition using householder reflections.

pub fn new_with_workspace(hess: MatrixN<N, D>, work: &mut VectorN<N, D>) -> Self

Computes the Hessenberg decomposition using householder reflections.

The workspace containing D elements must be provided but its content does not have to be initialized.

pub fn unpack(self) -> (MatrixN<N, D>, MatrixN<N, D>)where
    ShapeConstraint: DimEq<Dynamic, DimDiff<D, U1>>,

Retrieves (q, h) with q the orthogonal matrix of this decomposition and h the hessenberg matrix.

pub fn unpack_h(self) -> MatrixN<N, D>where
    ShapeConstraint: DimEq<Dynamic, DimDiff<D, U1>>,

Retrieves the upper trapezoidal submatrix H of this decomposition.

pub fn h(&self) -> MatrixN<N, D>where
    ShapeConstraint: DimEq<Dynamic, DimDiff<D, U1>>,

Retrieves the upper trapezoidal submatrix H of this decomposition.

This is less efficient than .unpack_h() as it allocates a new matrix.

pub fn q(&self) -> MatrixN<N, D>

Computes the orthogonal matrix Q of this decomposition.

Trait Implementations

impl<N: Clone + Real, D: Clone + DimSub<U1>> Clone for Hessenberg<N, D>where
    DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,

fn clone(&self) -> Hessenberg<N, D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug + Real, D: Debug + DimSub<U1>> Debug for Hessenberg<N, D>where
    DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,

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

Formats the value using the given formatter.

impl<N: Real, D: DimSub<U1>> Copy for Hessenberg<N, D>where
    DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,
    MatrixN<N, D>: Copy,
    VectorN<N, DimDiff<D, U1>>: Copy,