Struct nalgebra::linalg::Bidiagonal [−][src]
pub struct Bidiagonal<T: ComplexField, R: DimMin<C>, C: Dim> where
DimMinimum<R, C>: DimSub<U1>,
DefaultAllocator: Allocator<T, R, C> + Allocator<T, DimMinimum<R, C>> + Allocator<T, DimDiff<DimMinimum<R, C>, U1>>, { /* fields omitted */ }
Expand description
The bidiagonalization of a general matrix.
Implementations
impl<T: ComplexField, R: DimMin<C>, C: Dim> Bidiagonal<T, R, C> where
DimMinimum<R, C>: DimSub<U1>,
DefaultAllocator: Allocator<T, R, C> + Allocator<T, C> + Allocator<T, R> + Allocator<T, DimMinimum<R, C>> + Allocator<T, DimDiff<DimMinimum<R, C>, U1>>,
[src]
impl<T: ComplexField, R: DimMin<C>, C: Dim> Bidiagonal<T, R, C> where
DimMinimum<R, C>: DimSub<U1>,
DefaultAllocator: Allocator<T, R, C> + Allocator<T, C> + Allocator<T, R> + Allocator<T, DimMinimum<R, C>> + Allocator<T, DimDiff<DimMinimum<R, C>, U1>>,
[src]pub fn new(matrix: OMatrix<T, R, C>) -> Self
[src]
pub fn new(matrix: OMatrix<T, R, C>) -> Self
[src]Computes the Bidiagonal decomposition using householder reflections.
pub fn is_upper_diagonal(&self) -> bool
[src]
pub fn is_upper_diagonal(&self) -> bool
[src]Indicates whether this decomposition contains an upper-diagonal matrix.
pub fn unpack(
self
) -> (OMatrix<T, R, DimMinimum<R, C>>, OMatrix<T, DimMinimum<R, C>, DimMinimum<R, C>>, OMatrix<T, DimMinimum<R, C>, C>) where
DefaultAllocator: Allocator<T, DimMinimum<R, C>, DimMinimum<R, C>> + Allocator<T, R, DimMinimum<R, C>> + Allocator<T, DimMinimum<R, C>, C>,
[src]
pub fn unpack(
self
) -> (OMatrix<T, R, DimMinimum<R, C>>, OMatrix<T, DimMinimum<R, C>, DimMinimum<R, C>>, OMatrix<T, DimMinimum<R, C>, C>) where
DefaultAllocator: Allocator<T, DimMinimum<R, C>, DimMinimum<R, C>> + Allocator<T, R, DimMinimum<R, C>> + Allocator<T, DimMinimum<R, C>, C>,
[src]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) -> OMatrix<T, DimMinimum<R, C>, DimMinimum<R, C>> where
DefaultAllocator: Allocator<T, DimMinimum<R, C>, DimMinimum<R, C>>,
[src]
pub fn d(&self) -> OMatrix<T, DimMinimum<R, C>, DimMinimum<R, C>> where
DefaultAllocator: Allocator<T, DimMinimum<R, C>, DimMinimum<R, C>>,
[src]Retrieves the upper trapezoidal submatrix R
of this decomposition.
pub fn u(&self) -> OMatrix<T, R, DimMinimum<R, C>> where
DefaultAllocator: Allocator<T, R, DimMinimum<R, C>>,
[src]
pub fn u(&self) -> OMatrix<T, R, DimMinimum<R, C>> where
DefaultAllocator: Allocator<T, R, DimMinimum<R, C>>,
[src]Computes the orthogonal matrix U
of this U * D * V
decomposition.
pub fn v_t(&self) -> OMatrix<T, DimMinimum<R, C>, C> where
DefaultAllocator: Allocator<T, DimMinimum<R, C>, C>,
[src]
pub fn v_t(&self) -> OMatrix<T, DimMinimum<R, C>, C> where
DefaultAllocator: Allocator<T, DimMinimum<R, C>, C>,
[src]Computes the orthogonal matrix V_t
of this U * D * V_t
decomposition.
pub fn diagonal(&self) -> OVector<T::RealField, DimMinimum<R, C>> where
DefaultAllocator: Allocator<T::RealField, DimMinimum<R, C>>,
[src]
pub fn diagonal(&self) -> OVector<T::RealField, DimMinimum<R, C>> where
DefaultAllocator: Allocator<T::RealField, DimMinimum<R, C>>,
[src]The diagonal part of this decomposed matrix.
pub fn off_diagonal(
&self
) -> OVector<T::RealField, DimDiff<DimMinimum<R, C>, U1>> where
DefaultAllocator: Allocator<T::RealField, DimDiff<DimMinimum<R, C>, U1>>,
[src]
pub fn off_diagonal(
&self
) -> OVector<T::RealField, DimDiff<DimMinimum<R, C>, U1>> where
DefaultAllocator: Allocator<T::RealField, DimDiff<DimMinimum<R, C>, U1>>,
[src]The off-diagonal part of this decomposed matrix.
Trait Implementations
impl<T: Clone + ComplexField, R: Clone + DimMin<C>, C: Clone + Dim> Clone for Bidiagonal<T, R, C> where
DimMinimum<R, C>: DimSub<U1>,
DefaultAllocator: Allocator<T, R, C> + Allocator<T, DimMinimum<R, C>> + Allocator<T, DimDiff<DimMinimum<R, C>, U1>>,
[src]
impl<T: Clone + ComplexField, R: Clone + DimMin<C>, C: Clone + Dim> Clone for Bidiagonal<T, R, C> where
DimMinimum<R, C>: DimSub<U1>,
DefaultAllocator: Allocator<T, R, C> + Allocator<T, DimMinimum<R, C>> + Allocator<T, DimDiff<DimMinimum<R, C>, U1>>,
[src]fn clone(&self) -> Bidiagonal<T, R, C>
[src]
fn clone(&self) -> Bidiagonal<T, R, C>
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl<T: Debug + ComplexField, R: Debug + DimMin<C>, C: Debug + Dim> Debug for Bidiagonal<T, R, C> where
DimMinimum<R, C>: DimSub<U1>,
DefaultAllocator: Allocator<T, R, C> + Allocator<T, DimMinimum<R, C>> + Allocator<T, DimDiff<DimMinimum<R, C>, U1>>,
[src]
impl<T: Debug + ComplexField, R: Debug + DimMin<C>, C: Debug + Dim> Debug for Bidiagonal<T, R, C> where
DimMinimum<R, C>: DimSub<U1>,
DefaultAllocator: Allocator<T, R, C> + Allocator<T, DimMinimum<R, C>> + Allocator<T, DimDiff<DimMinimum<R, C>, U1>>,
[src]impl<T: ComplexField, R: DimMin<C>, C: Dim> Copy for Bidiagonal<T, R, C> where
DimMinimum<R, C>: DimSub<U1>,
DefaultAllocator: Allocator<T, R, C> + Allocator<T, DimMinimum<R, C>> + Allocator<T, DimDiff<DimMinimum<R, C>, U1>>,
OMatrix<T, R, C>: Copy,
OVector<T, DimMinimum<R, C>>: Copy,
OVector<T, DimDiff<DimMinimum<R, C>, U1>>: Copy,
[src]
DimMinimum<R, C>: DimSub<U1>,
DefaultAllocator: Allocator<T, R, C> + Allocator<T, DimMinimum<R, C>> + Allocator<T, DimDiff<DimMinimum<R, C>, U1>>,
OMatrix<T, R, C>: Copy,
OVector<T, DimMinimum<R, C>>: Copy,
OVector<T, DimDiff<DimMinimum<R, C>, U1>>: 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
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]pub fn to_subset(&self) -> Option<SS>
[src]
pub fn to_subset(&self) -> Option<SS>
[src]The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
[src]
pub fn is_in_subset(&self) -> bool
[src]Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
[src]
pub fn to_subset_unchecked(&self) -> SS
[src]Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
[src]
pub fn from_subset(element: &SS) -> SP
[src]The inclusion map: converts self
to the equivalent element of its superset.
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,