Struct linxal::svd::types::SVDSolution

pub struct SVDSolution<T: LinxalImplScalar> {
    pub values: Array<T::RealPart, Ix1>,
    pub left_vectors: Option<Array<T, Ix2>>,
    pub right_vectors: Option<Array<T, Ix2>>,
}

A solution to the singular value decomposition.

A singular value decomposition solution includes singular values and, optionally, the left and right singular vectors, stored as a mtrix.

Fields

values: Array<T::RealPart, Ix1>

Singular values of the matrix.

Singular values, which are guaranteed to be non-negative reals, are returned in descending order.

left_vectors: Option<Array<T, Ix2>>

The matrix U of left singular vectors.

right_vectors: Option<Array<T, Ix2>>

The matrix V^t of singular vectors.

The transpose of V is stored, not V itself.

Methods

impl<T: LinxalImplScalar> SVDSolution<T>

fn is_reconstructable(&self) -> bool

fn reconstruct(&self) -> Option<Array<T, Ix2>>

Reconstruct the original matrix if both left and right singular vectors are present.