Struct nalgebra::linalg::Hessenberg
source · pub struct Hessenberg<N: Real, D: DimSub<U1>>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,{ /* private fields */ }
Expand description
Hessenberg decomposition of a general matrix.
Implementations§
source§impl<N: Real, D: DimSub<U1>> Hessenberg<N, D>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, D> + Allocator<N, DimDiff<D, U1>>,
impl<N: Real, D: DimSub<U1>> Hessenberg<N, D>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, D> + Allocator<N, DimDiff<D, U1>>,
sourcepub fn new(hess: MatrixN<N, D>) -> Self
pub fn new(hess: MatrixN<N, D>) -> Self
Computes the Hessenberg decomposition using householder reflections.
sourcepub fn new_with_workspace(hess: MatrixN<N, D>, work: &mut VectorN<N, D>) -> Self
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.
sourcepub fn unpack(self) -> (MatrixN<N, D>, MatrixN<N, D>)where
ShapeConstraint: DimEq<Dynamic, DimDiff<D, U1>>,
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.
sourcepub fn unpack_h(self) -> MatrixN<N, D>where
ShapeConstraint: DimEq<Dynamic, DimDiff<D, U1>>,
pub fn unpack_h(self) -> MatrixN<N, D>where
ShapeConstraint: DimEq<Dynamic, DimDiff<D, U1>>,
Retrieves the upper trapezoidal submatrix H
of this decomposition.
Trait Implementations§
source§impl<N: Clone + Real, D: Clone + DimSub<U1>> Clone for Hessenberg<N, D>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,
impl<N: Clone + Real, D: Clone + DimSub<U1>> Clone for Hessenberg<N, D>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,
source§fn clone(&self) -> Hessenberg<N, D>
fn clone(&self) -> Hessenberg<N, D>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<N: Debug + Real, D: Debug + DimSub<U1>> Debug for Hessenberg<N, D>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,
impl<N: Debug + Real, D: Debug + DimSub<U1>> Debug for Hessenberg<N, D>where
DefaultAllocator: Allocator<N, D, D> + Allocator<N, DimDiff<D, U1>>,
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,
Auto Trait Implementations§
impl<N, D> !RefUnwindSafe for Hessenberg<N, D>
impl<N, D> !Send for Hessenberg<N, D>
impl<N, D> !Sync for Hessenberg<N, D>
impl<N, D> !Unpin for Hessenberg<N, D>
impl<N, D> !UnwindSafe for Hessenberg<N, D>
Blanket Implementations§
source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read moresource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).source§unsafe fn to_subset_unchecked(&self) -> SS
unsafe 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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.