Struct heron::rapier_plugin::rapier::parry::na::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>, }
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]
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>>,
pub fn new(
matrix: Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>,
compute_u: bool,
compute_v: bool
) -> SVD<T, R, C>
[src]
matrix: Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>,
compute_u: bool,
compute_v: bool
) -> SVD<T, R, C>
Computes the Singular Value Decomposition of matrix
using implicit shift.
pub fn try_new(
matrix: Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>,
compute_u: bool,
compute_v: bool,
eps: <T as ComplexField>::RealField,
max_niter: usize
) -> Option<SVD<T, R, C>>
[src]
matrix: Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>,
compute_u: bool,
compute_v: bool,
eps: <T as ComplexField>::RealField,
max_niter: usize
) -> Option<SVD<T, R, C>>
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.
pub fn rank(&self, eps: <T as ComplexField>::RealField) -> usize
[src]
Computes the rank of the decomposed matrix, i.e., the number of singular values greater
than eps
.
pub fn recompose(
self
) -> Result<Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>, &'static str>
[src]
self
) -> Result<Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>, &'static str>
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]
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>,
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
S2: Storage<T, R2, C2>,
R2: Dim,
C2: Dim,
DefaultAllocator: Allocator<T, C, C2>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, C2>,
ShapeConstraint: SameNumberOfRows<R, R2>,
[src]
&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
S2: Storage<T, R2, C2>,
R2: Dim,
C2: Dim,
DefaultAllocator: Allocator<T, C, C2>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, C2>,
ShapeConstraint: SameNumberOfRows<R, R2>,
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]
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,
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]
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,
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]
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,
Auto Trait Implementations
impl<T, R, C> !RefUnwindSafe for SVD<T, R, C>
impl<T, R, C> !Send for SVD<T, R, C>
impl<T, R, C> !Sync for SVD<T, R, C>
impl<T, R, C> !Unpin for SVD<T, R, C>
impl<T, R, C> !UnwindSafe for SVD<T, R, C>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Any for T where
T: Any,
T: Any,
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> CloneAny for T where
T: Any + Clone,
T: Any + Clone,
impl<T> Component for T where
T: 'static + Send + Sync,
T: 'static + Send + Sync,
impl<T> Downcast for T where
T: Any,
T: Any,
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn as_any(&self) -> &(dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
impl<T> Downcast<T> for T
impl<T> DowncastSync for T where
T: Any + Send + Sync,
T: Any + Send + Sync,
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Pointable for T
pub const ALIGN: usize
type Init = T
The type for initializers.
pub unsafe fn init(init: <T as Pointable>::Init) -> usize
pub unsafe fn deref<'a>(ptr: usize) -> &'a T
pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
pub unsafe fn drop(ptr: usize)
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
SS: SubsetOf<SP>,
pub fn to_subset(&self) -> Option<SS>
pub fn is_in_subset(&self) -> bool
pub fn to_subset_unchecked(&self) -> SS
pub fn from_subset(element: &SS) -> SP
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<T> TypeData for T where
T: 'static + Send + Sync + Clone,
T: 'static + Send + Sync + Clone,
pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>
impl<T> Upcast<T> for T
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,