reverie_engine_opengl::math::nalgebra

Struct Bidiagonal

Source 
pub struct Bidiagonal<T, R, C>
where
    T: ComplexField,
    R: DimMin<C>,
    C: Dim,
    <R as DimMin<C>>::Output: DimSub<Const<1>>,
    DefaultAllocator: Allocator<R, C> + Allocator<<R as DimMin<C>>::Output> + Allocator<<<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output>,
{ /* private fields */ }
Expand description

The bidiagonalization of a general matrix.

Implementations§

Source§

impl<T, R, C> Bidiagonal<T, R, C>
where T: ComplexField, R: DimMin<C>, C: Dim, <R as DimMin<C>>::Output: DimSub<Const<1>>, DefaultAllocator: Allocator<R, C> + Allocator<C> + Allocator<R> + Allocator<<R as DimMin<C>>::Output> + Allocator<<<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output>,

Source

pub fn new( matrix: Matrix<T, R, C, <DefaultAllocator as Allocator<R, C>>::Buffer<T>>, ) -> Bidiagonal<T, R, C>

Computes the Bidiagonal decomposition using householder reflections.

Source

pub fn is_upper_diagonal(&self) -> bool

Indicates whether this decomposition contains an upper-diagonal matrix.

Source

pub fn unpack( self, ) -> (Matrix<T, R, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<R, <R as DimMin<C>>::Output>>::Buffer<T>>, Matrix<T, <R as DimMin<C>>::Output, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<<R as DimMin<C>>::Output, <R as DimMin<C>>::Output>>::Buffer<T>>, Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<<R as DimMin<C>>::Output, C>>::Buffer<T>>)
where DefaultAllocator: Allocator<<R as DimMin<C>>::Output, <R as DimMin<C>>::Output> + Allocator<R, <R as DimMin<C>>::Output> + Allocator<<R as DimMin<C>>::Output, C>,

Unpacks this decomposition into its three matrix factors (U, D, V^t).

The decomposed matrix M is equal to U * D * V^t.

Source

pub fn d( &self, ) -> Matrix<T, <R as DimMin<C>>::Output, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<<R as DimMin<C>>::Output, <R as DimMin<C>>::Output>>::Buffer<T>>
where DefaultAllocator: Allocator<<R as DimMin<C>>::Output, <R as DimMin<C>>::Output>,

Retrieves the upper trapezoidal submatrix R of this decomposition.

Source

pub fn u( &self, ) -> Matrix<T, R, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<R, <R as DimMin<C>>::Output>>::Buffer<T>>
where DefaultAllocator: Allocator<R, <R as DimMin<C>>::Output>,

Computes the orthogonal matrix U of this U * D * V decomposition.

Source

pub fn v_t( &self, ) -> Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<<R as DimMin<C>>::Output, C>>::Buffer<T>>
where DefaultAllocator: Allocator<<R as DimMin<C>>::Output, C>,

Computes the orthogonal matrix V_t of this U * D * V_t decomposition.

Source

pub fn diagonal( &self, ) -> Matrix<<T as ComplexField>::RealField, <R as DimMin<C>>::Output, Const<1>, <DefaultAllocator as Allocator<<R as DimMin<C>>::Output>>::Buffer<<T as ComplexField>::RealField>>
where DefaultAllocator: Allocator<<R as DimMin<C>>::Output>,

The diagonal part of this decomposed matrix.

Source

pub fn off_diagonal( &self, ) -> Matrix<<T as ComplexField>::RealField, <<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output, Const<1>, <DefaultAllocator as Allocator<<<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output>>::Buffer<<T as ComplexField>::RealField>>
where DefaultAllocator: Allocator<<<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output>,

The off-diagonal part of this decomposed matrix.

Trait Implementations§

Source§

impl<T, R, C> Clone for Bidiagonal<T, R, C>
where T: Clone + ComplexField, R: Clone + DimMin<C>, C: Clone + Dim, <R as DimMin<C>>::Output: DimSub<Const<1>>, DefaultAllocator: Allocator<R, C> + Allocator<<R as DimMin<C>>::Output> + Allocator<<<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output>,

Source§

fn clone(&self) -> Bidiagonal<T, R, C>

Returns a duplicate 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, R, C> Debug for Bidiagonal<T, R, C>
where T: Debug + ComplexField, R: Debug + DimMin<C>, C: Debug + Dim, <R as DimMin<C>>::Output: DimSub<Const<1>>, DefaultAllocator: Allocator<R, C> + Allocator<<R as DimMin<C>>::Output> + Allocator<<<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output>,

Source§

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

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

impl<T, R, C> Copy for Bidiagonal<T, R, C>
where T: ComplexField, R: DimMin<C>, C: Dim, <R as DimMin<C>>::Output: DimSub<Const<1>>, DefaultAllocator: Allocator<R, C> + Allocator<<R as DimMin<C>>::Output> + Allocator<<<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output>, Matrix<T, R, C, <DefaultAllocator as Allocator<R, C>>::Buffer<T>>: Copy, Matrix<T, <R as DimMin<C>>::Output, Const<1>, <DefaultAllocator as Allocator<<R as DimMin<C>>::Output>>::Buffer<T>>: Copy, Matrix<T, <<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output, Const<1>, <DefaultAllocator as Allocator<<<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output>>::Buffer<T>>: Copy,

Auto Trait Implementations§

§

impl<T, R, C> !Freeze for Bidiagonal<T, R, C>

§

impl<T, R, C> !RefUnwindSafe for Bidiagonal<T, R, C>

§

impl<T, R, C> !Send for Bidiagonal<T, R, C>

§

impl<T, R, C> !Sync for Bidiagonal<T, R, C>

§

impl<T, R, C> !Unpin for Bidiagonal<T, R, C>

§

impl<T, R, C> !UnwindSafe for Bidiagonal<T, R, C>

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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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 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<U> 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<U>>::Error>

Performs the conversion.
Source§

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

Source§

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.