Struct na::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<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 */ }
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<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>>,
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>>,
sourcepub fn new(
matrix: Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>
) -> Bidiagonal<T, R, C>
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.
sourcepub fn is_upper_diagonal(&self) -> bool
pub fn is_upper_diagonal(&self) -> bool
Indicates whether this decomposition contains an upper-diagonal matrix.
sourcepub 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>,
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
.
sourcepub 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>,
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.
sourcepub 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>,
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.
sourcepub 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>,
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.
sourcepub 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>>,
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.
sourcepub 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>>,
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§
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<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>>,
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>>,
source§fn clone(&self) -> Bidiagonal<T, R, C>
fn clone(&self) -> Bidiagonal<T, R, C>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§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>>,
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>>,
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,
Auto Trait Implementations§
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,
source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read moresource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.