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>
impl<T, R, C> Bidiagonal<T, R, C>
Sourcepub fn new(
matrix: Matrix<T, R, C, <DefaultAllocator as Allocator<R, C>>::Buffer<T>>,
) -> Bidiagonal<T, R, C>
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.
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<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>>)
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>>)
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<<R as DimMin<C>>::Output, <R as DimMin<C>>::Output>>::Buffer<T>>
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>>
Retrieves the upper trapezoidal submatrix R
of this decomposition.
Sourcepub fn u(
&self,
) -> Matrix<T, R, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<R, <R as DimMin<C>>::Output>>::Buffer<T>>
pub fn u( &self, ) -> Matrix<T, R, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<R, <R as DimMin<C>>::Output>>::Buffer<T>>
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<<R as DimMin<C>>::Output, C>>::Buffer<T>>
pub fn v_t( &self, ) -> Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<<R as DimMin<C>>::Output, C>>::Buffer<T>>
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<<R as DimMin<C>>::Output>>::Buffer<<T as ComplexField>::RealField>>
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>>
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<<<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output>>::Buffer<<T as ComplexField>::RealField>>
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>>
The off-diagonal part of this decomposed matrix.
Trait Implementations§
Source§impl<T, R, C> Clone for Bidiagonal<T, R, C>
impl<T, R, C> Clone for Bidiagonal<T, R, C>
Source§fn clone(&self) -> Bidiagonal<T, R, C>
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)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreSource§impl<T, R, C> Debug for Bidiagonal<T, R, C>
impl<T, R, C> Debug for Bidiagonal<T, R, C>
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> 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<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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.