Struct Hessenberg

pub struct Hessenberg<T, D>
where
    T: ComplexField,
    D: DimSub<Const<1>>,
    DefaultAllocator: Allocator<T, D, D> + Allocator<T, <D as DimSub<Const<1>>>::Output>,
{ /* private fields */ }

Hessenberg decomposition of a general matrix.

Implementations

impl<T, D> Hessenberg<T, D>

where T: ComplexField, D: DimSub<Const<1>>, DefaultAllocator: Allocator<T, D, D> + Allocator<T, D> + Allocator<T, <D as DimSub<Const<1>>>::Output>,

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

Computes the Hessenberg decomposition using householder reflections.

pub fn new_with_workspace( hess: Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>, work: &mut Matrix<T, D, Const<1>, <DefaultAllocator as Allocator<T, D>>::Buffer>, ) -> Hessenberg<T, D>

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, ) -> (Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>, Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>)

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

pub fn unpack_h( self, ) -> Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>

Retrieves the upper trapezoidal submatrix H of this decomposition.

pub fn h( &self, ) -> Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>

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, ) -> Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>

Computes the orthogonal matrix Q of this decomposition.

Trait Implementations

impl<T, D> Clone for Hessenberg<T, D>

where T: Clone + ComplexField, D: Clone + DimSub<Const<1>>, DefaultAllocator: Allocator<T, D, D> + Allocator<T, <D as DimSub<Const<1>>>::Output>,

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, D> Debug for Hessenberg<T, D>

where T: Debug + ComplexField, D: Debug + DimSub<Const<1>>, DefaultAllocator: Allocator<T, D, D> + Allocator<T, <D as DimSub<Const<1>>>::Output>,

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

Formats the value using the given formatter.

impl<'de, T, D> Deserialize<'de> for Hessenberg<T, D>

where T: ComplexField, D: DimSub<Const<1>>, DefaultAllocator: Allocator<T, D, D> + Allocator<T, <D as DimSub<Const<1>>>::Output>, Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>: Deserialize<'de>, Matrix<T, <D as DimSub<Const<1>>>::Output, Const<1>, <DefaultAllocator as Allocator<T, <D as DimSub<Const<1>>>::Output>>::Buffer>: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Hessenberg<T, D>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, D> Serialize for Hessenberg<T, D>

where T: ComplexField, D: DimSub<Const<1>>, DefaultAllocator: Allocator<T, D, D> + Allocator<T, <D as DimSub<Const<1>>>::Output>, Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>: Serialize, Matrix<T, <D as DimSub<Const<1>>>::Output, Const<1>, <DefaultAllocator as Allocator<T, <D as DimSub<Const<1>>>::Output>>::Buffer>: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T, D> Copy for Hessenberg<T, D>

where T: ComplexField, D: DimSub<Const<1>>, DefaultAllocator: Allocator<T, D, D> + Allocator<T, <D as DimSub<Const<1>>>::Output>, Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>: Copy, Matrix<T, <D as DimSub<Const<1>>>::Output, Const<1>, <DefaultAllocator as Allocator<T, <D as DimSub<Const<1>>>::Output>>::Buffer>: Copy,