Struct ggez::graphics::na::Bidiagonal

pub struct Bidiagonal<N, R, C> where
    C: Dim,
    N: Real,
    R: DimMin<C>,
    <R as DimMin<C>>::Output: DimSub<U1>,
    DefaultAllocator: Allocator<N, R, C>,
    DefaultAllocator: Allocator<N, <R as DimMin<C>>::Output, U1>,
    DefaultAllocator: Allocator<N, <<R as DimMin<C>>::Output as DimSub<U1>>::Output, U1>,  {
    pub diagonal: Matrix<N, <R as DimMin<C>>::Output, U1, <DefaultAllocator as Allocator<N, <R as DimMin<C>>::Output, U1>>::Buffer>,
    pub off_diagonal: Matrix<N, <<R as DimMin<C>>::Output as DimSub<U1>>::Output, U1, <DefaultAllocator as Allocator<N, <<R as DimMin<C>>::Output as DimSub<U1>>::Output, U1>>::Buffer>,
    // some fields omitted
}

The bidiagonalization of a general matrix.

Fields

diagonal: Matrix<N, <R as DimMin<C>>::Output, U1, <DefaultAllocator as Allocator<N, <R as DimMin<C>>::Output, U1>>::Buffer>

The diagonal elements of the decomposed matrix.

off_diagonal: Matrix<N, <<R as DimMin<C>>::Output as DimSub<U1>>::Output, U1, <DefaultAllocator as Allocator<N, <<R as DimMin<C>>::Output as DimSub<U1>>::Output, U1>>::Buffer>

The off-diagonal elements of the decomposed matrix.

Methods

impl<N, R, C> Bidiagonal<N, R, C> where
    C: Dim,
    N: Real,
    R: DimMin<C>,
    <R as DimMin<C>>::Output: DimSub<U1>,
    DefaultAllocator: Allocator<N, R, C>,
    DefaultAllocator: Allocator<N, C, U1>,
    DefaultAllocator: Allocator<N, R, U1>,
    DefaultAllocator: Allocator<N, <R as DimMin<C>>::Output, U1>,
    DefaultAllocator: Allocator<N, <<R as DimMin<C>>::Output as DimSub<U1>>::Output, U1>, 

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

Computes the Bidiagonal decomposition using householder reflections.

fn is_upper_diagonal(&self) -> bool

Indicates whether this decomposition contains an upper-diagonal matrix.

fn unpack(
    self
) -> (Matrix<N, R, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<N, R, <R as DimMin<C>>::Output>>::Buffer>, Matrix<N, <R as DimMin<C>>::Output, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<N, <R as DimMin<C>>::Output, <R as DimMin<C>>::Output>>::Buffer>, Matrix<N, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<N, <R as DimMin<C>>::Output, C>>::Buffer>) where
    DefaultAllocator: Allocator<N, <R as DimMin<C>>::Output, <R as DimMin<C>>::Output>,
    DefaultAllocator: Allocator<N, R, <R as DimMin<C>>::Output>,
    DefaultAllocator: Allocator<N, <R as DimMin<C>>::Output, C>,
    <R as DimMin<C>>::Output: DimMin<<R as DimMin<C>>::Output>,
    ShapeConstraint: DimEq<Dynamic, <<R as DimMin<C>>::Output as DimSub<U1>>::Output>,
    <<R as DimMin<C>>::Output as DimMin<<R as DimMin<C>>::Output>>::Output == <R as DimMin<C>>::Output, 

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

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

fn d(
    &self
) -> Matrix<N, <R as DimMin<C>>::Output, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<N, <R as DimMin<C>>::Output, <R as DimMin<C>>::Output>>::Buffer> where
    DefaultAllocator: Allocator<N, <R as DimMin<C>>::Output, <R as DimMin<C>>::Output>,
    <R as DimMin<C>>::Output: DimMin<<R as DimMin<C>>::Output>,
    ShapeConstraint: DimEq<Dynamic, <<R as DimMin<C>>::Output as DimSub<U1>>::Output>,
    <<R as DimMin<C>>::Output as DimMin<<R as DimMin<C>>::Output>>::Output == <R as DimMin<C>>::Output, 

Retrieves the upper trapezoidal submatrix R of this decomposition.

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

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

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

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

fn diagonal(
    &self
) -> &Matrix<N, <R as DimMin<C>>::Output, U1, <DefaultAllocator as Allocator<N, <R as DimMin<C>>::Output, U1>>::Buffer>

The diagonal part of this decomposed matrix.

fn off_diagonal(
    &self
) -> &Matrix<N, <<R as DimMin<C>>::Output as DimSub<U1>>::Output, U1, <DefaultAllocator as Allocator<N, <<R as DimMin<C>>::Output as DimSub<U1>>::Output, U1>>::Buffer>

The off-diagonal part of this decomposed matrix.

Trait Implementations

impl<N, R, C> Copy for Bidiagonal<N, R, C> where
    C: Dim,
    N: Real,
    R: DimMin<C>,
    <R as DimMin<C>>::Output: DimSub<U1>,
    DefaultAllocator: Allocator<N, R, C>,
    DefaultAllocator: Allocator<N, <R as DimMin<C>>::Output, U1>,
    DefaultAllocator: Allocator<N, <<R as DimMin<C>>::Output as DimSub<U1>>::Output, U1>,
    Matrix<N, R, C, <DefaultAllocator as Allocator<N, R, C>>::Buffer>: Copy,
    Matrix<N, <R as DimMin<C>>::Output, U1, <DefaultAllocator as Allocator<N, <R as DimMin<C>>::Output, U1>>::Buffer>: Copy,
    Matrix<N, <<R as DimMin<C>>::Output as DimSub<U1>>::Output, U1, <DefaultAllocator as Allocator<N, <<R as DimMin<C>>::Output as DimSub<U1>>::Output, U1>>::Buffer>: Copy, 

impl<N, R, C> Clone for Bidiagonal<N, R, C> where
    C: Dim + Clone,
    N: Clone + Real,
    R: DimMin<C> + Clone,
    <R as DimMin<C>>::Output: DimSub<U1>,
    DefaultAllocator: Allocator<N, R, C>,
    DefaultAllocator: Allocator<N, <R as DimMin<C>>::Output, U1>,
    DefaultAllocator: Allocator<N, <<R as DimMin<C>>::Output as DimSub<U1>>::Output, U1>, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N, R, C> Debug for Bidiagonal<N, R, C> where
    C: Dim + Debug,
    N: Debug + Real,
    R: DimMin<C> + Debug,
    <R as DimMin<C>>::Output: DimSub<U1>,
    DefaultAllocator: Allocator<N, R, C>,
    DefaultAllocator: Allocator<N, <R as DimMin<C>>::Output, U1>,
    DefaultAllocator: Allocator<N, <<R as DimMin<C>>::Output as DimSub<U1>>::Output, U1>, 

fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.