Struct nalgebra::linalg::Hessenberg

source · [−]

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

Expand description

Hessenberg decomposition of a general matrix.

Implementations

source

impl<T: ComplexField, D: DimSub<U1>> Hessenberg<T, D> where
DefaultAllocator: Allocator<T, D, D> + Allocator<T, D> + Allocator<T, DimDiff<D, U1>>,

source

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

Computes the Hessenberg decomposition using householder reflections.

source

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.

source

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.

source

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

Retrieves the upper trapezoidal submatrix H of this decomposition.

source

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.

source

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

Computes the orthogonal matrix Q of this decomposition.

Trait Implementations

source

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

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: Debug + ComplexField, D: Debug + DimSub<U1>> Debug for Hessenberg<T, D> where
DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>,

source

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

Formats the value using the given formatter. Read more

source

impl<'de, T: ComplexField, D: DimSub<U1>> Deserialize<'de> for Hessenberg<T, D> where
 DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>,
 DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>,
 OMatrix<T, D, D>: Deserialize<'de>,
 OVector<T, DimDiff<D, U1>>: Deserialize<'de>,

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl<T: ComplexField, D: DimSub<U1>> Serialize for Hessenberg<T, D> where
 DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>,
 DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>,
 OMatrix<T, D, D>: Serialize,
 OVector<T, DimDiff<D, U1>>: Serialize,

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

source

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,

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 T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.

source

fn pointer_metadata(
&<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<F, W, T, D> Deserialize<With<T, W>, D> for F where
 W: DeserializeWith<F, T, D>,
 D: Fallible + ?Sized,
 F: ?Sized,

source

fn deserialize(
&self,
deserializer: &mut D
) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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.

impl<T> Pointee for T

type Metadata = ()

The type for metadata in pointers and references to Self.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<SS, SP> SupersetOf<SS> for SP where
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<SS, SP> SupersetOf<SS> for SP where
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

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

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

source

impl<T> ToOwned for T where
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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct nalgebra::linalg::Hessenberg

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

pub fn new_with_workspace( hess: OMatrix<T, D, D>, work: &mut OVector<T, D>) -> Self

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

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

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

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

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>

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

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where __D: Deserializer<'de>,

impl<T: ComplexField, D: DimSub<U1>> Serialize for Hessenberg<T, D> where DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>, 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,

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,

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

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

fn type_id(&self) -> TypeId

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

fn pointer_metadata( &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata

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

fn borrow(&self) -> &T

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

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

impl<F, W, T, D> Deserialize<With<T, W>, D> for F where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

fn deserialize( &self, deserializer: &mut D) -> Result<With<T, W>, <D as Fallible>::Error>

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Pointee for T

type Metadata = ()

impl<T> Same<T> for T

type Output = T

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

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

fn is_in_subset(&self) -> bool

fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

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

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

fn is_in_subset(&self) -> bool

unsafe fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

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

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

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 deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

impl<T: ComplexField, D: DimSub<U1>> Serialize for Hessenberg<T, D> where
DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>,
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,

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,

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

fn pointer_metadata(
&<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata

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

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

impl<F, W, T, D> Deserialize<With<T, W>, D> for F where
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,

fn deserialize(
&self,
deserializer: &mut D
) -> Result<With<T, W>, <D as Fallible>::Error>

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

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

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

impl<T> ToOwned for T where
T: Clone,

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,