Struct na::Bidiagonal

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

The bidiagonalization of a general matrix.

Implementations

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<T, R, C> + Allocator<T, C, Const<1>> + Allocator<T, R, Const<1>> + Allocator<T, <R as DimMin<C>>::Output, Const<1>> + Allocator<T, <<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output, Const<1>>,

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

Computes the Bidiagonal decomposition using householder reflections.

pub fn is_upper_diagonal(&self) -> bool

Indicates whether this decomposition contains an upper-diagonal matrix.

pub fn unpack( self ) -> (Matrix<T, R, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<T, R, <R as DimMin<C>>::Output>>::Buffer>, Matrix<T, <R as DimMin<C>>::Output, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, <R as DimMin<C>>::Output>>::Buffer>, Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, C>>::Buffer>)where DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, <R as DimMin<C>>::Output> + Allocator<T, R, <R as DimMin<C>>::Output> + Allocator<T, <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.

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

Retrieves the upper trapezoidal submatrix R of this decomposition.

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

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

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

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

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

The diagonal part of this decomposed matrix.

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<<T as ComplexField>::RealField, <<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output, Const<1>>>::Buffer>where DefaultAllocator: Allocator<<T as ComplexField>::RealField, <<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output, Const<1>>,

The off-diagonal part of this decomposed matrix.

Trait Implementations

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<T, R, C> + Allocator<T, <R as DimMin<C>>::Output, Const<1>> + Allocator<T, <<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output, Const<1>>,

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

Returns a copy of the value.

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

Performs copy-assignment from 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<T, R, C> + Allocator<T, <R as DimMin<C>>::Output, Const<1>> + Allocator<T, <<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output, Const<1>>,

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

Formats the value using the given formatter.

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<T, R, C> + Allocator<T, <R as DimMin<C>>::Output, Const<1>> + Allocator<T, <<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output, Const<1>>, Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>: Copy, Matrix<T, <R as DimMin<C>>::Output, Const<1>, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, Const<1>>>::Buffer>: Copy, Matrix<T, <<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output, Const<1>, <DefaultAllocator as Allocator<T, <<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output, Const<1>>>::Buffer>: Copy,