Struct nalgebra::linalg::Hessenberg

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

Hessenberg decomposition of a general matrix.

Implementations

impl<T: ComplexField, D: DimSub<U1>> Hessenberg<T, D>

where DefaultAllocator: Allocator<T, D, D> + Allocator<T, D> + Allocator<T, DimDiff<D, U1>>,

pub fn new(hess: OMatrix<T, D, D>) -> Self

Computes the Hessenberg decomposition using householder reflections.

pub fn new_with_workspace( hess: OMatrix<T, D, D>, work: &mut OVector<T, 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) -> (OMatrix<T, D, D>, OMatrix<T, D, D>)

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

pub fn unpack_h(self) -> OMatrix<T, D, D>

Retrieves the upper trapezoidal submatrix H of this decomposition.

pub fn h(&self) -> OMatrix<T, D, D>

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) -> OMatrix<T, D, D>

Computes the orthogonal matrix Q of this decomposition.

Trait Implementations

impl<T: Clone + ComplexField, D: Clone + DimSub<U1>> Clone for Hessenberg<T, D>

where DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ComplexField, D: Debug + DimSub<U1>> Debug for Hessenberg<T, D>

where DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>,

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

Formats the value using the given formatter.

impl<'de, T: ComplexField, D: DimSub<U1>> Deserialize<'de> for Hessenberg<T, D>

where DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>, OMatrix<T, D, D>: Deserialize<'de>, OVector<T, DimDiff<D, U1>>: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: ComplexField, D: DimSub<U1>> Serialize for Hessenberg<T, D>

where DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>, OMatrix<T, D, D>: Serialize, OVector<T, DimDiff<D, U1>>: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: ComplexField, D: DimSub<U1>> Copy for Hessenberg<T, D>

where DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>, OMatrix<T, D, D>: Copy, OVector<T, DimDiff<D, U1>>: Copy,