Struct SvdResult 

pub struct SvdResult<T: TensorScalar> { /* private fields */ }

Result of SVD decomposition A = U * diag(S) * Vt. The singular values are stored in a real-valued typed tensor, even when the input matrix is complex.

Examples

use tensor4all_tensorbackend::svd_backend;
use tenferro::TypedTensor;
let a = TypedTensor::<f64>::from_vec_col_major(vec![2, 2], vec![1.0, 0.0, 0.0, 2.0])?;
let result = svd_backend(&a)?;
assert_eq!(result.u().shape(), &[2, 2]);
assert_eq!(result.s().shape(), &[2]);
assert_eq!(result.vt().shape(), &[2, 2]);

Implementations

impl<T: TensorScalar> SvdResult<T>

pub fn u(&self) -> &TypedTensor<T>

Borrow the left singular vectors.

pub fn s(&self) -> &TypedTensor<T::Real>

Borrow the singular values.

pub fn vt(&self) -> &TypedTensor<T>

Borrow the transposed right singular vectors.

pub fn into_parts( self, ) -> (TypedTensor<T>, TypedTensor<T::Real>, TypedTensor<T>)

Consume the decomposition into (U, S, Vt).

Trait Implementations

impl<T: TensorScalar> Clone for SvdResult<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + TensorScalar> Debug for SvdResult<T>

where T::Real: Debug,

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

Formats the value using the given formatter.