Struct SymmetricTridiagonal

Source

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

Expand description

Tridiagonalization of a symmetric matrix.

Implementations§

Source §

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

Source

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

Computes the tridiagonalization of the symmetric matrix m.

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

Source

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

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

Source

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

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

Source

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

The diagonal components of this decomposition.

Source

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

The off-diagonal components of this decomposition.

Source

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

Computes the orthogonal matrix Q of this decomposition.

Source

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

Recomputes the original symmetric matrix.

Trait Implementations§

Source §

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

Source §

fn clone(&self) -> SymmetricTridiagonal<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 SymmetricTridiagonal<T, D>
where DefaultAllocator: Allocator<D, D> + Allocator<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 SymmetricTridiagonal<T, D>
where DefaultAllocator: Allocator<D, D> + Allocator<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 SymmetricTridiagonal<T, D>
where DefaultAllocator: Allocator<D, D> + Allocator<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 SymmetricTridiagonal<T, D>
where DefaultAllocator: Allocator<D, D> + Allocator<DimDiff<D, U1>>, OMatrix<T, D, D>: Copy, OVector<T, DimDiff<D, U1>>: Copy,

Auto Trait Implementations§

§

impl<T, D> !UnwindSafe for SymmetricTridiagonal<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> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

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

Source §

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

Mutably borrows from an owned value. Read more

Source §

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

Source §

unsafe fn clone_to_uninit(&self, dst: *mut T)

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

Performs copy-assignment from self to dst. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

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

Source §

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<T> ToOwned for T
where T: Clone,

Source §

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

Source §

type Error = Infallible

The type returned in the event of a conversion error.

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Source §

Struct SymmetricTridiagonalCopy item path

Implementations§

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

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

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

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

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

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

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

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

Trait Implementations§

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

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

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

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

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

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

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

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

Auto Trait Implementations§

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

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut T)

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Same for T

type Output = T

impl<SS, SP> SupersetOf<SS> for SPwhere 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<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,

Struct SymmetricTridiagonal

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,