Struct nalgebra::linalg::SymmetricTridiagonal[][src]

pub struct SymmetricTridiagonal<T: ComplexField, D: DimSub<U1>> where
    DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>, 
{ /* fields omitted */ }
Expand description

Tridiagonalization of a symmetric matrix.

Implementations

impl<T: ComplexField, D: DimSub<U1>> SymmetricTridiagonal<T, D> where
    DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>, 
[src]

pub fn new(m: OMatrix<T, D, D>) -> Self[src]

Computes the tridiagonalization of the symmetric matrix m.

Only the lower-triangular part (including the diagonal) of m is read.

pub fn unpack(
    self
) -> (OMatrix<T, D, D>, OVector<T::RealField, D>, OVector<T::RealField, DimDiff<D, U1>>) where
    DefaultAllocator: Allocator<T::RealField, D> + Allocator<T::RealField, DimDiff<D, U1>>, 
[src]

Retrieve the orthogonal transformation, diagonal, and off diagonal elements of this decomposition.

pub fn unpack_tridiagonal(
    self
) -> (OVector<T::RealField, D>, OVector<T::RealField, DimDiff<D, U1>>) where
    DefaultAllocator: Allocator<T::RealField, D> + Allocator<T::RealField, DimDiff<D, U1>>, 
[src]

Retrieve the diagonal, and off diagonal elements of this decomposition.

pub fn diagonal(&self) -> OVector<T::RealField, D> where
    DefaultAllocator: Allocator<T::RealField, D>, 
[src]

The diagonal components of this decomposition.

pub fn off_diagonal(&self) -> OVector<T::RealField, DimDiff<D, U1>> where
    DefaultAllocator: Allocator<T::RealField, DimDiff<D, U1>>, 
[src]

The off-diagonal components of this decomposition.

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

Computes the orthogonal matrix Q of this decomposition.

pub fn recompose(self) -> OMatrix<T, D, D>[src]

Recomputes the original symmetric matrix.

Trait Implementations

impl<T: Clone + ComplexField, D: Clone + DimSub<U1>> Clone for SymmetricTridiagonal<T, D> where
    DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>, 
[src]

fn clone(&self) -> SymmetricTridiagonal<T, D>[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<T: Debug + ComplexField, D: Debug + DimSub<U1>> Debug for SymmetricTridiagonal<T, D> where
    DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>, 
[src]

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

Formats the value using the given formatter. Read more

impl<T: ComplexField, D: DimSub<U1>> Copy for SymmetricTridiagonal<T, D> where
    DefaultAllocator: Allocator<T, D, D> + Allocator<T, DimDiff<D, U1>>,
    OMatrix<T, D, D>: Copy,
    OVector<T, DimDiff<D, U1>>: Copy
[src]

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> Same<T> for T[src]

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, 
[src]

pub fn to_subset(&self) -> Option<SS>[src]

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

pub fn is_in_subset(&self) -> bool[src]

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

pub fn to_subset_unchecked(&self) -> SS[src]

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

pub fn from_subset(element: &SS) -> SP[src]

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

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

pub fn vzip(self) -> V