Struct bevy_rapier2d::prelude::nalgebra::linalg::SVD [−][src]
pub struct SVD<T, R, C> where
C: Dim,
T: ComplexField,
R: DimMin<C>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, C>,
DefaultAllocator: Allocator<T, R, <R as DimMin<C>>::Output>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <R as DimMin<C>>::Output, Const<1_usize>>, { pub u: Option<Matrix<T, R, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<T, R, <R as DimMin<C>>::Output>>::Buffer>>, pub v_t: Option<Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, C>>::Buffer>>, pub singular_values: 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>, }
Expand description
Singular Value Decomposition of a general matrix.
Fields
u: Option<Matrix<T, R, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<T, R, <R as DimMin<C>>::Output>>::Buffer>>
The left-singular vectors U
of this SVD.
v_t: Option<Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, C>>::Buffer>>
The right-singular vectors V^t
of this SVD.
singular_values: 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>
The singular values of this SVD.
Implementations
impl<T, R, C> SVD<T, R, C> where
C: Dim,
T: ComplexField,
R: DimMin<C>,
<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 as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, C>,
DefaultAllocator: Allocator<T, R, <R as DimMin<C>>::Output>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, Const<1_usize>>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <R as DimMin<C>>::Output, Const<1_usize>>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <<R as DimMin<C>>::Output as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
[src]
impl<T, R, C> SVD<T, R, C> where
C: Dim,
T: ComplexField,
R: DimMin<C>,
<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 as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, C>,
DefaultAllocator: Allocator<T, R, <R as DimMin<C>>::Output>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, Const<1_usize>>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <R as DimMin<C>>::Output, Const<1_usize>>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <<R as DimMin<C>>::Output as DimSub<Const<1_usize>>>::Output, Const<1_usize>>,
[src]Computes the Singular Value Decomposition of matrix
using implicit shift.
Attempts to compute the Singular Value Decomposition of matrix
using implicit shift.
Arguments
compute_u
− set this totrue
to enable the computation of left-singular vectors.compute_v
− set this totrue
to enable the computation of right-singular vectors.eps
− tolerance used to determine when a value converged to 0.max_niter
− maximum total number of iterations performed by the algorithm. If this number of iteration is exceeded,None
is returned. Ifniter == 0
, then the algorithm continues indefinitely until convergence.
Computes the rank of the decomposed matrix, i.e., the number of singular values greater
than eps
.
Rebuild the original matrix.
This is useful if some of the singular values have been manually modified.
Returns Err
if the right- and left- singular vectors have not been
computed at construction-time.
pub fn pseudo_inverse(
self,
eps: <T as ComplexField>::RealField
) -> Result<Matrix<T, C, R, <DefaultAllocator as Allocator<T, C, R>>::Buffer>, &'static str> where
DefaultAllocator: Allocator<T, C, R>,
[src]
pub fn pseudo_inverse(
self,
eps: <T as ComplexField>::RealField
) -> Result<Matrix<T, C, R, <DefaultAllocator as Allocator<T, C, R>>::Buffer>, &'static str> where
DefaultAllocator: Allocator<T, C, R>,
[src]Computes the pseudo-inverse of the decomposed matrix.
Any singular value smaller than eps
is assumed to be zero.
Returns Err
if the right- and left- singular vectors have not
been computed at construction-time.
pub fn solve<R2, C2, S2>(
&self,
b: &Matrix<T, R2, C2, S2>,
eps: <T as ComplexField>::RealField
) -> Result<Matrix<T, C, C2, <DefaultAllocator as Allocator<T, C, C2>>::Buffer>, &'static str> where
C2: Dim,
S2: Storage<T, R2, C2>,
R2: Dim,
DefaultAllocator: Allocator<T, C, C2>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, C2>,
ShapeConstraint: SameNumberOfRows<R, R2>,
[src]
pub fn solve<R2, C2, S2>(
&self,
b: &Matrix<T, R2, C2, S2>,
eps: <T as ComplexField>::RealField
) -> Result<Matrix<T, C, C2, <DefaultAllocator as Allocator<T, C, C2>>::Buffer>, &'static str> where
C2: Dim,
S2: Storage<T, R2, C2>,
R2: Dim,
DefaultAllocator: Allocator<T, C, C2>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, C2>,
ShapeConstraint: SameNumberOfRows<R, R2>,
[src]Solves the system self * x = b
where self
is the decomposed matrix and x
the unknown.
Any singular value smaller than eps
is assumed to be zero.
Returns Err
if the singular vectors U
and V
have not been computed.
Trait Implementations
impl<T, R, C> Clone for SVD<T, R, C> where
C: Clone + Dim,
T: Clone + ComplexField,
R: Clone + DimMin<C>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, C>,
DefaultAllocator: Allocator<T, R, <R as DimMin<C>>::Output>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <R as DimMin<C>>::Output, Const<1_usize>>,
<T as ComplexField>::RealField: Clone,
[src]
impl<T, R, C> Clone for SVD<T, R, C> where
C: Clone + Dim,
T: Clone + ComplexField,
R: Clone + DimMin<C>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, C>,
DefaultAllocator: Allocator<T, R, <R as DimMin<C>>::Output>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <R as DimMin<C>>::Output, Const<1_usize>>,
<T as ComplexField>::RealField: Clone,
[src]impl<T, R, C> Debug for SVD<T, R, C> where
C: Debug + Dim,
T: Debug + ComplexField,
R: Debug + DimMin<C>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, C>,
DefaultAllocator: Allocator<T, R, <R as DimMin<C>>::Output>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <R as DimMin<C>>::Output, Const<1_usize>>,
<T as ComplexField>::RealField: Debug,
[src]
impl<T, R, C> Debug for SVD<T, R, C> where
C: Debug + Dim,
T: Debug + ComplexField,
R: Debug + DimMin<C>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, C>,
DefaultAllocator: Allocator<T, R, <R as DimMin<C>>::Output>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <R as DimMin<C>>::Output, Const<1_usize>>,
<T as ComplexField>::RealField: Debug,
[src]impl<T, R, C> Copy for SVD<T, R, C> where
C: Dim,
T: ComplexField,
R: DimMin<C>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, C>,
DefaultAllocator: Allocator<T, R, <R as DimMin<C>>::Output>,
DefaultAllocator: Allocator<<T as ComplexField>::RealField, <R as DimMin<C>>::Output, Const<1_usize>>,
Matrix<T, R, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<T, R, <R as DimMin<C>>::Output>>::Buffer>: Copy,
Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, C>>::Buffer>: Copy,
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>: Copy,
[src]Auto Trait Implementations
impl<T, R, C> !RefUnwindSafe for SVD<T, R, C>
impl<T, R, C> !UnwindSafe for SVD<T, R, C>
Blanket Implementations
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
type Output = T
type Output = T
Should always be Self
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>
pub fn vzip(self) -> V