Struct nalgebra_lapack::SVD [−][src]
The SVD decomposition of a general matrix.
Fields
u: MatrixN<N, R>
The left-singular vectors U
of this SVD.
vt: MatrixN<N, C>
The right-singular vectors V^t
of this SVD.
singular_values: VectorN<N, DimMinimum<R, C>>
The singular values of this SVD.
Implementations
impl<N: SVDScalar<R, C>, R: DimMin<C>, C: Dim> SVD<N, R, C> where
DefaultAllocator: Allocator<N, R, R> + Allocator<N, R, C> + Allocator<N, DimMinimum<R, C>> + Allocator<N, C, C>,
[src]
DefaultAllocator: Allocator<N, R, R> + Allocator<N, R, C> + Allocator<N, DimMinimum<R, C>> + Allocator<N, C, C>,
pub fn new(m: MatrixMN<N, R, C>) -> Option<Self>
[src]
Computes the Singular Value Decomposition of matrix
.
impl<R: DimMin<C>, C: Dim> SVD<f32, R, C> where
DefaultAllocator: Allocator<f32, R, C> + Allocator<f32, C, R> + Allocator<f32, U1, R> + Allocator<f32, U1, C> + Allocator<f32, R, R> + Allocator<f32, DimMinimum<R, C>> + Allocator<f32, DimMinimum<R, C>, R> + Allocator<f32, DimMinimum<R, C>, C> + Allocator<f32, R, DimMinimum<R, C>> + Allocator<f32, C, C>,
[src]
DefaultAllocator: Allocator<f32, R, C> + Allocator<f32, C, R> + Allocator<f32, U1, R> + Allocator<f32, U1, C> + Allocator<f32, R, R> + Allocator<f32, DimMinimum<R, C>> + Allocator<f32, DimMinimum<R, C>, R> + Allocator<f32, DimMinimum<R, C>, C> + Allocator<f32, R, DimMinimum<R, C>> + Allocator<f32, C, C>,
pub fn recompose(self) -> MatrixMN<f32, R, C>
[src]
Reconstructs the matrix from its decomposition.
Useful if some components (e.g. some singular values) of this decomposition have been manually changed by the user.
pub fn pseudo_inverse(&self, epsilon: f32) -> MatrixMN<f32, C, R>
[src]
Computes the pseudo-inverse of the decomposed matrix.
All singular value below epsilon will be set to zero instead of being inverted.
pub fn rank(&self, epsilon: f32) -> usize
[src]
The rank of the decomposed matrix.
This is the number of singular values that are not too small (i.e. greater than
the given epsilon
).
impl<R: DimMin<C>, C: Dim> SVD<f64, R, C> where
DefaultAllocator: Allocator<f64, R, C> + Allocator<f64, C, R> + Allocator<f64, U1, R> + Allocator<f64, U1, C> + Allocator<f64, R, R> + Allocator<f64, DimMinimum<R, C>> + Allocator<f64, DimMinimum<R, C>, R> + Allocator<f64, DimMinimum<R, C>, C> + Allocator<f64, R, DimMinimum<R, C>> + Allocator<f64, C, C>,
[src]
DefaultAllocator: Allocator<f64, R, C> + Allocator<f64, C, R> + Allocator<f64, U1, R> + Allocator<f64, U1, C> + Allocator<f64, R, R> + Allocator<f64, DimMinimum<R, C>> + Allocator<f64, DimMinimum<R, C>, R> + Allocator<f64, DimMinimum<R, C>, C> + Allocator<f64, R, DimMinimum<R, C>> + Allocator<f64, C, C>,
pub fn recompose(self) -> MatrixMN<f64, R, C>
[src]
Reconstructs the matrix from its decomposition.
Useful if some components (e.g. some singular values) of this decomposition have been manually changed by the user.
pub fn pseudo_inverse(&self, epsilon: f64) -> MatrixMN<f64, C, R>
[src]
Computes the pseudo-inverse of the decomposed matrix.
All singular value below epsilon will be set to zero instead of being inverted.
pub fn rank(&self, epsilon: f64) -> usize
[src]
The rank of the decomposed matrix.
This is the number of singular values that are not too small (i.e. greater than
the given epsilon
).
Trait Implementations
impl<N: Clone + Scalar, R: Clone + DimMin<C>, C: Clone + Dim> Clone for SVD<N, R, C> where
DefaultAllocator: Allocator<N, R, R> + Allocator<N, DimMinimum<R, C>> + Allocator<N, C, C>,
[src]
DefaultAllocator: Allocator<N, R, R> + Allocator<N, DimMinimum<R, C>> + Allocator<N, C, C>,
impl<N: Scalar + Copy, R: DimMin<C>, C: Dim> Copy for SVD<N, R, C> where
DefaultAllocator: Allocator<N, C, C> + Allocator<N, R, R> + Allocator<N, DimMinimum<R, C>>,
MatrixMN<N, R, R>: Copy,
MatrixMN<N, C, C>: Copy,
VectorN<N, DimMinimum<R, C>>: Copy,
[src]
DefaultAllocator: Allocator<N, C, C> + Allocator<N, R, R> + Allocator<N, DimMinimum<R, C>>,
MatrixMN<N, R, R>: Copy,
MatrixMN<N, C, C>: Copy,
VectorN<N, DimMinimum<R, C>>: Copy,
impl<N: Debug + Scalar, R: Debug + DimMin<C>, C: Debug + Dim> Debug for SVD<N, R, C> where
DefaultAllocator: Allocator<N, R, R> + Allocator<N, DimMinimum<R, C>> + Allocator<N, C, C>,
[src]
DefaultAllocator: Allocator<N, R, R> + Allocator<N, DimMinimum<R, C>> + Allocator<N, C, C>,
Auto Trait Implementations
impl<N, R, C> !RefUnwindSafe for SVD<N, R, C>
impl<N, R, C> !Send for SVD<N, R, C>
impl<N, R, C> !Sync for SVD<N, R, C>
impl<N, R, C> !Unpin for SVD<N, R, C>
impl<N, R, C> !UnwindSafe for SVD<N, R, C>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]
SS: SubsetOf<SP>,
pub fn to_subset(&self) -> Option<SS>
[src]
pub fn is_in_subset(&self) -> bool
[src]
pub fn to_subset_unchecked(&self) -> SS
[src]
pub fn from_subset(element: &SS) -> SP
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,