Struct extendr_api::prelude::solvers::Svd

pub struct Svd<E>
where
    E: Entity,
{
    s: Col<E>,
    u: Mat<E>,
    v: Mat<E>,
}

Singular value decomposition.

Fields

s: Col<E>

u: Mat<E>

v: Mat<E>

Implementations

impl<E> Svd<E>

where E: ComplexField,

pub fn new<ViewE>(matrix: MatRef<'_, ViewE>) -> Svd<E>

where ViewE: Conjugate<Canonical = E>,

Returns the SVD of the input matrix.

The factorization is such that $A = U S V^H$, where $U$ and $V$ are unitary and $S$ is a rectangular diagonal matrix.

pub fn u(&self) -> MatRef<'_, E>

Returns the factor $U$ of the SVD.

pub fn s_diagonal(&self) -> ColRef<'_, E>

Returns the diagonal of the factor $S$ of the SVD as a column vector.

pub fn v(&self) -> MatRef<'_, E>

Returns the factor $V$ of the SVD.

pub fn pseudoinverse(&self) -> Mat<E>

Computes the pseudo inverse.

Trait Implementations

impl<E> Debug for Svd<E>

where E: Debug + Entity,

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

Formats the value using the given formatter.

impl<E> SolverCore<E> for Svd<E>

where E: ComplexField,

fn reconstruct(&self) -> Mat<E>

Reconstructs the original matrix using the decomposition.

fn inverse(&self) -> Mat<E>

Computes the inverse of the original matrix using the decomposition.

impl<E> SpSolverCore<E> for Svd<E>

where E: ComplexField,

fn nrows(&self) -> usize

Returns the number of rows of the matrix used to construct this decomposition.

fn ncols(&self) -> usize

Returns the number of columns of the matrix used to construct this decomposition.