Struct na::Hessenberg

source ·
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, Const<1>>,{ /* private fields */ }
Expand description

Hessenberg decomposition of a general matrix.

Implementations§

source§

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

source

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.

source

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, Const<1>>>::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.

source

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.

source

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.

source

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.

source

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§

source§

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, Const<1>>,

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
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, Const<1>>,

source§

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

Formats the value using the given formatter. Read more
source§

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, Const<1>>, 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, Const<1>>>::Buffer>: Copy,

Auto Trait Implementations§

§

impl<T, D> !RefUnwindSafe for Hessenberg<T, D>

§

impl<T, D> !Send for Hessenberg<T, D>

§

impl<T, D> !Sync for Hessenberg<T, D>

§

impl<T, D> !Unpin for Hessenberg<T, D>

§

impl<T, D> !UnwindSafe for Hessenberg<T, D>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<V> IntoPnt<V> for V

source§

fn into_pnt(self) -> V

source§

impl<V> IntoVec<V> for V

source§

fn into_vec(self) -> V

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,

source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.