SVD

fyrox_impl::renderer::framework::core::algebra

Struct SVD 

Source 
pub struct SVD<T, R, C>
where
    T: ComplexField,
    R: DimMin<C>,
    C: Dim,
    DefaultAllocator: Allocator<<R as DimMin<C>>::Output, C> + Allocator<R, <R as DimMin<C>>::Output> + Allocator<<R as DimMin<C>>::Output>,
{
    pub u: Option<Matrix<T, R, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<R, <R as DimMin<C>>::Output>>::Buffer<T>>>,
    pub v_t: Option<Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<<R as DimMin<C>>::Output, C>>::Buffer<T>>>,
    pub singular_values: Matrix<<T as ComplexField>::RealField, <R as DimMin<C>>::Output, Const<1>, <DefaultAllocator as Allocator<<R as DimMin<C>>::Output>>::Buffer<<T as ComplexField>::RealField>>,
}
Expand description

Singular Value Decomposition of a general matrix.

Fields§

§u: Option<Matrix<T, R, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<R, <R as DimMin<C>>::Output>>::Buffer<T>>>

The left-singular vectors U of this SVD.

§v_t: Option<Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<<R as DimMin<C>>::Output, C>>::Buffer<T>>>

The right-singular vectors V^t of this SVD.

§singular_values: Matrix<<T as ComplexField>::RealField, <R as DimMin<C>>::Output, Const<1>, <DefaultAllocator as Allocator<<R as DimMin<C>>::Output>>::Buffer<<T as ComplexField>::RealField>>

The singular values of this SVD.

Implementations§

Source§

impl<T, R, C> SVD<T, R, C>
where T: ComplexField, R: DimMin<C>, C: Dim, <R as DimMin<C>>::Output: DimSub<Const<1>>, DefaultAllocator: Allocator<R, C> + Allocator<C> + Allocator<R> + Allocator<<<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output> + Allocator<<R as DimMin<C>>::Output, C> + Allocator<R, <R as DimMin<C>>::Output> + Allocator<<R as DimMin<C>>::Output>,

Source

pub fn new_unordered( matrix: Matrix<T, R, C, <DefaultAllocator as Allocator<R, C>>::Buffer<T>>, compute_u: bool, compute_v: bool, ) -> SVD<T, R, C>

Computes the Singular Value Decomposition of matrix using implicit shift. The singular values are not guaranteed to be sorted in any particular order. If a descending order is required, consider using new instead.

Source

pub fn try_new_unordered( matrix: Matrix<T, R, C, <DefaultAllocator as Allocator<R, C>>::Buffer<T>>, 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. The singular values are not guaranteed to be sorted in any particular order. If a descending order is required, consider using try_new instead.

§Arguments
  • compute_u − set this to true to enable the computation of left-singular vectors.
  • compute_v − set this to true 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. If niter == 0, then the algorithm continues indefinitely until convergence.
Source

pub fn rank(&self, eps: <T as ComplexField>::RealField) -> usize

Computes the rank of the decomposed matrix, i.e., the number of singular values greater than eps.

Source

pub fn recompose( self, ) -> Result<Matrix<T, R, C, <DefaultAllocator as Allocator<R, C>>::Buffer<T>>, &'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.

Source

pub fn pseudo_inverse( self, eps: <T as ComplexField>::RealField, ) -> Result<Matrix<T, C, R, <DefaultAllocator as Allocator<C, R>>::Buffer<T>>, &'static str>
where DefaultAllocator: Allocator<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.

Source

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<C, C2>>::Buffer<T>>, &'static str>
where R2: Dim, C2: Dim, S2: Storage<T, R2, C2>, DefaultAllocator: Allocator<C, C2> + Allocator<<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.

Source

pub fn to_polar( &self, ) -> Option<(Matrix<T, R, R, <DefaultAllocator as Allocator<R, R>>::Buffer<T>>, Matrix<T, R, C, <DefaultAllocator as Allocator<R, C>>::Buffer<T>>)>
where DefaultAllocator: Allocator<R, C> + Allocator<<R as DimMin<C>>::Output, R> + Allocator<<R as DimMin<C>>::Output> + Allocator<R, R> + Allocator<<R as DimMin<C>>::Output, <R as DimMin<C>>::Output>,

converts SVD results to Polar decomposition form of the original Matrix: A = P' * U.

The polar decomposition used here is Left Polar Decomposition (or Reverse Polar Decomposition) Returns None if the singular vectors of the SVD haven’t been calculated

Source§

impl<T, R, C> SVD<T, R, C>
where T: ComplexField, R: DimMin<C>, C: Dim, <R as DimMin<C>>::Output: DimSub<Const<1>>, DefaultAllocator: Allocator<R, C> + Allocator<C> + Allocator<R> + Allocator<<<R as DimMin<C>>::Output as DimSub<Const<1>>>::Output> + Allocator<<R as DimMin<C>>::Output, C> + Allocator<R, <R as DimMin<C>>::Output> + Allocator<<R as DimMin<C>>::Output>,

Source

pub fn new( matrix: Matrix<T, R, C, <DefaultAllocator as Allocator<R, C>>::Buffer<T>>, compute_u: bool, compute_v: bool, ) -> SVD<T, R, C>

Computes the Singular Value Decomposition of matrix using implicit shift. The singular values are guaranteed to be sorted in descending order. If this order is not required consider using new_unordered.

Source

pub fn try_new( matrix: Matrix<T, R, C, <DefaultAllocator as Allocator<R, C>>::Buffer<T>>, 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. The singular values are guaranteed to be sorted in descending order. If this order is not required consider using try_new_unordered.

§Arguments
  • compute_u − set this to true to enable the computation of left-singular vectors.
  • compute_v − set this to true 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. If niter == 0, then the algorithm continues indefinitely until convergence.
Source

pub fn sort_by_singular_values(&mut self)

Sort the estimated components of the SVD by its singular values in descending order. Such an ordering is often implicitly required when the decompositions are used for estimation or fitting purposes. Using this function is only required if new_unordered or try_new_unordered were used and the specific sorting is required afterward.

Trait Implementations§

Source§

impl<T, R, C> Clone for SVD<T, R, C>
where T: Clone + ComplexField, R: Clone + DimMin<C>, C: Clone + Dim, DefaultAllocator: Allocator<<R as DimMin<C>>::Output, C> + Allocator<R, <R as DimMin<C>>::Output> + Allocator<<R as DimMin<C>>::Output>, <T as ComplexField>::RealField: Clone,

Source§

fn clone(&self) -> SVD<T, R, C>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T, R, C> Debug for SVD<T, R, C>
where T: Debug + ComplexField, R: Debug + DimMin<C>, C: Debug + Dim, DefaultAllocator: Allocator<<R as DimMin<C>>::Output, C> + Allocator<R, <R as DimMin<C>>::Output> + Allocator<<R as DimMin<C>>::Output>, <T as ComplexField>::RealField: Debug,

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl<'de, T, R, C> Deserialize<'de> for SVD<T, R, C>
where T: ComplexField, R: DimMin<C>, C: Dim, DefaultAllocator: Allocator<<R as DimMin<C>>::Output, C> + Allocator<R, <R as DimMin<C>>::Output> + Allocator<<R as DimMin<C>>::Output>, Matrix<T, R, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<R, <R as DimMin<C>>::Output>>::Buffer<T>>: Deserialize<'de>, Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<<R as DimMin<C>>::Output, C>>::Buffer<T>>: Deserialize<'de>, Matrix<<T as ComplexField>::RealField, <R as DimMin<C>>::Output, Const<1>, <DefaultAllocator as Allocator<<R as DimMin<C>>::Output>>::Buffer<<T as ComplexField>::RealField>>: Deserialize<'de>,

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<SVD<T, R, C>, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<T, R, C> Serialize for SVD<T, R, C>
where T: ComplexField, R: DimMin<C>, C: Dim, DefaultAllocator: Allocator<<R as DimMin<C>>::Output, C> + Allocator<R, <R as DimMin<C>>::Output> + Allocator<<R as DimMin<C>>::Output>, Matrix<T, R, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<R, <R as DimMin<C>>::Output>>::Buffer<T>>: Serialize, Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<<R as DimMin<C>>::Output, C>>::Buffer<T>>: Serialize, Matrix<<T as ComplexField>::RealField, <R as DimMin<C>>::Output, Const<1>, <DefaultAllocator as Allocator<<R as DimMin<C>>::Output>>::Buffer<<T as ComplexField>::RealField>>: Serialize,

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<T, R, C> Copy for SVD<T, R, C>
where T: ComplexField, R: DimMin<C>, C: Dim, DefaultAllocator: Allocator<<R as DimMin<C>>::Output, C> + Allocator<R, <R as DimMin<C>>::Output> + Allocator<<R as DimMin<C>>::Output>, Matrix<T, R, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<R, <R as DimMin<C>>::Output>>::Buffer<T>>: Copy, Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<<R as DimMin<C>>::Output, C>>::Buffer<T>>: Copy, Matrix<<T as ComplexField>::RealField, <R as DimMin<C>>::Output, Const<1>, <DefaultAllocator as Allocator<<R as DimMin<C>>::Output>>::Buffer<<T as ComplexField>::RealField>>: Copy,

Auto Trait Implementations§

§

impl<T, R, C> !Freeze for SVD<T, R, C>

§

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§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AsyncTaskResult for T
where T: Any + Send + 'static,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn 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.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

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.
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts self reference as a reference to Any. Could be used to downcast a trait object to a particular type.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts self reference as a reference to Any. Could be used to downcast a trait object to a particular type.
Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> FieldValue for T
where T: 'static,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Casts self to a &dyn Any
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ScriptMessagePayload for T
where T: 'static + Send + Debug,

Source§

fn as_any_ref(&self) -> &(dyn Any + 'static)

Returns self as &dyn Any
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns self as &dyn Any
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ResourceLoadError for T
where T: 'static + Debug + Send + Sync,