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_usize>>,
DefaultAllocator: Allocator<T, R, C>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, Const<1_usize>>,
DefaultAllocator: Allocator<T, <<R as DimMin<C>>::Output as DimSub<Const<1_usize>>>::Output, Const<1_usize>>, { /* private fields */ }
Expand description
The bidiagonalization of a general matrix.
Implementations
sourceimpl<T, R, C> Bidiagonal<T, R, C> where
T: ComplexField,
R: DimMin<C>,
C: Dim,
<R as DimMin<C>>::Output: DimSub<Const<1_usize>>,
DefaultAllocator: Allocator<T, R, C>,
DefaultAllocator: Allocator<T, C, Const<1_usize>>,
DefaultAllocator: Allocator<T, R, Const<1_usize>>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, Const<1_usize>>,
DefaultAllocator: Allocator<T, <<R as DimMin<C>>::Output as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
impl<T, R, C> Bidiagonal<T, R, C> where
T: ComplexField,
R: DimMin<C>,
C: Dim,
<R as DimMin<C>>::Output: DimSub<Const<1_usize>>,
DefaultAllocator: Allocator<T, R, C>,
DefaultAllocator: Allocator<T, C, Const<1_usize>>,
DefaultAllocator: Allocator<T, R, Const<1_usize>>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, Const<1_usize>>,
DefaultAllocator: Allocator<T, <<R as DimMin<C>>::Output as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
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>,
DefaultAllocator: Allocator<T, R, <R as DimMin<C>>::Output>,
DefaultAllocator: 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>,
DefaultAllocator: Allocator<T, R, <R as DimMin<C>>::Output>,
DefaultAllocator: 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_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, <R as DimMin<C>>::Output, Const<1_usize>>>::Buffer> where
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <R as DimMin<C>>::Output, Const<1_usize>>,
pub fn diagonal(
&self
) -> Matrix<<T as ComplexField>::RealField, <R as DimMin<C>>::Output, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, <R as DimMin<C>>::Output, Const<1_usize>>>::Buffer> where
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <R as DimMin<C>>::Output, Const<1_usize>>,
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_usize>>>::Output, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, <<R as DimMin<C>>::Output as DimSub<Const<1_usize>>>::Output, Const<1_usize>>>::Buffer> where
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <<R as DimMin<C>>::Output as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
pub fn off_diagonal(
&self
) -> Matrix<<T as ComplexField>::RealField, <<R as DimMin<C>>::Output as DimSub<Const<1_usize>>>::Output, Const<1_usize>, <DefaultAllocator as Allocator<<T as ComplexField>::RealField, <<R as DimMin<C>>::Output as DimSub<Const<1_usize>>>::Output, Const<1_usize>>>::Buffer> where
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <<R as DimMin<C>>::Output as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
The off-diagonal part of this decomposed matrix.
Trait Implementations
sourceimpl<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_usize>>,
DefaultAllocator: Allocator<T, R, C>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, Const<1_usize>>,
DefaultAllocator: Allocator<T, <<R as DimMin<C>>::Output as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
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_usize>>,
DefaultAllocator: Allocator<T, R, C>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, Const<1_usize>>,
DefaultAllocator: Allocator<T, <<R as DimMin<C>>::Output as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
sourcefn clone(&self) -> Bidiagonal<T, R, C>
fn clone(&self) -> Bidiagonal<T, R, C>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<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_usize>>,
DefaultAllocator: Allocator<T, R, C>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, Const<1_usize>>,
DefaultAllocator: Allocator<T, <<R as DimMin<C>>::Output as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
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_usize>>,
DefaultAllocator: Allocator<T, R, C>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, Const<1_usize>>,
DefaultAllocator: Allocator<T, <<R as DimMin<C>>::Output as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
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_usize>>,
DefaultAllocator: Allocator<T, R, C>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, Const<1_usize>>,
DefaultAllocator: Allocator<T, <<R as DimMin<C>>::Output as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>: Copy,
Matrix<T, <R as DimMin<C>>::Output, Const<1_usize>, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, Const<1_usize>>>::Buffer>: Copy,
Matrix<T, <<R as DimMin<C>>::Output as DimSub<Const<1_usize>>>::Output, Const<1_usize>, <DefaultAllocator as Allocator<T, <<R as DimMin<C>>::Output as DimSub<Const<1_usize>>>::Output, Const<1_usize>>>::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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
sourcefn 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 more
sourcefn 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).
sourcefn 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.
sourcefn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more