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>>,
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>>,
Computes the Bidiagonal decomposition using householder reflections.
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>,
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>,
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>>,
pub fn d(&self) -> OMatrix<T, DimMinimum<R, C>, DimMinimum<R, C>> where
DefaultAllocator: Allocator<T, DimMinimum<R, C>, DimMinimum<R, C>>,
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>>,
pub fn u(&self) -> OMatrix<T, R, DimMinimum<R, C>> where
DefaultAllocator: Allocator<T, R, DimMinimum<R, C>>,
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>,
pub fn v_t(&self) -> OMatrix<T, DimMinimum<R, C>, C> where
DefaultAllocator: Allocator<T, DimMinimum<R, C>, C>,
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>>,
pub fn diagonal(&self) -> OVector<T::RealField, DimMinimum<R, C>> where
DefaultAllocator: Allocator<T::RealField, DimMinimum<R, C>>,
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>>,
pub fn off_diagonal(
&self
) -> OVector<T::RealField, DimDiff<DimMinimum<R, C>, U1>> where
DefaultAllocator: Allocator<T::RealField, DimDiff<DimMinimum<R, C>, U1>>,
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>>,
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>>,
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>>,
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>>,
impl<'de, T: ComplexField, R: DimMin<C>, C: Dim> Deserialize<'de> 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>>,
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>: Deserialize<'de>,
OVector<T, DimMinimum<R, C>>: Deserialize<'de>,
OVector<T, DimDiff<DimMinimum<R, C>, U1>>: Deserialize<'de>,
impl<'de, T: ComplexField, R: DimMin<C>, C: Dim> Deserialize<'de> 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>>,
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>: Deserialize<'de>,
OVector<T, DimMinimum<R, C>>: Deserialize<'de>,
OVector<T, DimDiff<DimMinimum<R, C>, U1>>: Deserialize<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl<T: ComplexField, R: DimMin<C>, C: Dim> Serialize 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>>,
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>: Serialize,
OVector<T, DimMinimum<R, C>>: Serialize,
OVector<T, DimDiff<DimMinimum<R, C>, U1>>: Serialize,
impl<T: ComplexField, R: DimMin<C>, C: Dim> Serialize 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>>,
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>: Serialize,
OVector<T, DimMinimum<R, C>>: Serialize,
OVector<T, DimDiff<DimMinimum<R, C>, U1>>: Serialize,
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,
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
Mutably borrows from an owned value. Read more
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
Checks if self
is actually part of its subset T
(and can be converted to it).
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
The inclusion map: converts self
to the equivalent element of its superset.