Struct SVD

pub struct SVD<A: Scalar> {
    pub u: Array2<A>,
    pub s: Array1<A::Real>,
    pub vt: Array2<A>,
}

This structure stores the Singular Value Decomposition of a matrix

Fields

u: Array2<A>

The U matrix

s: Array1<A::Real>

The array of singular values

vt: Array2<A>

The vt matrix

Trait Implementations

impl SVDTraits for SVD<c32>

type A = Complex<f32>

fn get_u(&self) -> ArrayView2<'_, Self::A>

fn get_s(&self) -> ArrayView1<'_, <Self::A as Scalar>::Real>

fn get_vt(&self) -> ArrayView2<'_, Self::A>

fn get_u_mut(&mut self) -> ArrayViewMut2<'_, Self::A>

fn get_s_mut(&mut self) -> ArrayViewMut1<'_, <Self::A as Scalar>::Real>

fn get_vt_mut(&mut self) -> ArrayViewMut2<'_, Self::A>

fn to_qr(self) -> Result<QR<Self::A>>

Convert to a QR Decomposition.

fn compute_from(arr: ArrayView2<'_, Self::A>) -> Result<SVD<Self::A>>

fn compute_from_range_estimate<Op: ConjMatMat<A = Self::A>>( range: ArrayView2<'_, Self::A>, op: &Op, ) -> Result<SVD<Self::A>>

Compute a singular value decomposition from a range estimate

fn nrows(&self) -> usize

Return the number of rows of the underlying operator

fn ncols(&self) -> usize

Return the number of columns of the underlying operator

fn rank(&self) -> usize

Return the rank of the underlying operator

fn to_mat(&self) -> Array2<Self::A>

Convert to a matrix.

fn compress(&self, compression_type: CompressionType) -> Result<SVD<Self::A>>

Compress to SVD.

fn compress_svd_rank(&self, max_rank: usize) -> Result<SVD<Self::A>>

Compress the SVD by specifying a target rank.

fn compress_svd_tolerance(&self, tol: f64) -> Result<SVD<Self::A>>

Compress the SVD by specifying a relative tolerance.

impl SVDTraits for SVD<c64>

type A = Complex<f64>

fn get_u(&self) -> ArrayView2<'_, Self::A>

fn get_s(&self) -> ArrayView1<'_, <Self::A as Scalar>::Real>

fn get_vt(&self) -> ArrayView2<'_, Self::A>

fn get_u_mut(&mut self) -> ArrayViewMut2<'_, Self::A>

fn get_s_mut(&mut self) -> ArrayViewMut1<'_, <Self::A as Scalar>::Real>

fn get_vt_mut(&mut self) -> ArrayViewMut2<'_, Self::A>

fn to_qr(self) -> Result<QR<Self::A>>

Convert to a QR Decomposition.

fn compute_from(arr: ArrayView2<'_, Self::A>) -> Result<SVD<Self::A>>

fn compute_from_range_estimate<Op: ConjMatMat<A = Self::A>>( range: ArrayView2<'_, Self::A>, op: &Op, ) -> Result<SVD<Self::A>>

Compute a singular value decomposition from a range estimate

fn nrows(&self) -> usize

Return the number of rows of the underlying operator

fn ncols(&self) -> usize

Return the number of columns of the underlying operator

fn rank(&self) -> usize

Return the rank of the underlying operator

fn to_mat(&self) -> Array2<Self::A>

Convert to a matrix.

fn compress(&self, compression_type: CompressionType) -> Result<SVD<Self::A>>

Compress to SVD.

fn compress_svd_rank(&self, max_rank: usize) -> Result<SVD<Self::A>>

Compress the SVD by specifying a target rank.

fn compress_svd_tolerance(&self, tol: f64) -> Result<SVD<Self::A>>

Compress the SVD by specifying a relative tolerance.

impl SVDTraits for SVD<f32>

type A = f32

fn get_u(&self) -> ArrayView2<'_, Self::A>

fn get_s(&self) -> ArrayView1<'_, <Self::A as Scalar>::Real>

fn get_vt(&self) -> ArrayView2<'_, Self::A>

fn get_u_mut(&mut self) -> ArrayViewMut2<'_, Self::A>

fn get_s_mut(&mut self) -> ArrayViewMut1<'_, <Self::A as Scalar>::Real>

fn get_vt_mut(&mut self) -> ArrayViewMut2<'_, Self::A>

fn to_qr(self) -> Result<QR<Self::A>>

Convert to a QR Decomposition.

fn compute_from(arr: ArrayView2<'_, Self::A>) -> Result<SVD<Self::A>>

fn compute_from_range_estimate<Op: ConjMatMat<A = Self::A>>( range: ArrayView2<'_, Self::A>, op: &Op, ) -> Result<SVD<Self::A>>

Compute a singular value decomposition from a range estimate

fn nrows(&self) -> usize

Return the number of rows of the underlying operator

fn ncols(&self) -> usize

Return the number of columns of the underlying operator

fn rank(&self) -> usize

Return the rank of the underlying operator

fn to_mat(&self) -> Array2<Self::A>

Convert to a matrix.

fn compress(&self, compression_type: CompressionType) -> Result<SVD<Self::A>>

Compress to SVD.

fn compress_svd_rank(&self, max_rank: usize) -> Result<SVD<Self::A>>

Compress the SVD by specifying a target rank.

fn compress_svd_tolerance(&self, tol: f64) -> Result<SVD<Self::A>>

Compress the SVD by specifying a relative tolerance.

impl SVDTraits for SVD<f64>

type A = f64

fn get_u(&self) -> ArrayView2<'_, Self::A>

fn get_s(&self) -> ArrayView1<'_, <Self::A as Scalar>::Real>

fn get_vt(&self) -> ArrayView2<'_, Self::A>

fn get_u_mut(&mut self) -> ArrayViewMut2<'_, Self::A>

fn get_s_mut(&mut self) -> ArrayViewMut1<'_, <Self::A as Scalar>::Real>

fn get_vt_mut(&mut self) -> ArrayViewMut2<'_, Self::A>

fn to_qr(self) -> Result<QR<Self::A>>

Convert to a QR Decomposition.

fn compute_from(arr: ArrayView2<'_, Self::A>) -> Result<SVD<Self::A>>

fn compute_from_range_estimate<Op: ConjMatMat<A = Self::A>>( range: ArrayView2<'_, Self::A>, op: &Op, ) -> Result<SVD<Self::A>>

Compute a singular value decomposition from a range estimate

fn nrows(&self) -> usize

Return the number of rows of the underlying operator

fn ncols(&self) -> usize

Return the number of columns of the underlying operator

fn rank(&self) -> usize

Return the rank of the underlying operator

fn to_mat(&self) -> Array2<Self::A>

Convert to a matrix.

fn compress(&self, compression_type: CompressionType) -> Result<SVD<Self::A>>

Compress to SVD.

fn compress_svd_rank(&self, max_rank: usize) -> Result<SVD<Self::A>>

Compress the SVD by specifying a target rank.

fn compress_svd_tolerance(&self, tol: f64) -> Result<SVD<Self::A>>

Compress the SVD by specifying a relative tolerance.