Struct rusty_compression::svd::SVD

source · [−]

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

Expand description

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

source

impl SVDTraits for SVD<f32>

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

Convert to a QR Decomposition.

source

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

source

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 Read more

source

fn nrows(&self) -> usize

Return the number of rows of the underlying operator

source

fn ncols(&self) -> usize

Return the number of columns of the underlying operator

source

fn rank(&self) -> usize

Return the rank of the underlying operator

source

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

Convert to a matrix.

source

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

Compress to SVD.

source

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

Compress the SVD by specifying a target rank.

source

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

Compress the SVD by specifying a relative tolerance.

source

impl SVDTraits for SVD<f64>

type A = f64

source

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

source

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

source

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

source

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

source

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

source

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

source

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

Convert to a QR Decomposition.

source

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

source

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 Read more

source

fn nrows(&self) -> usize

Return the number of rows of the underlying operator

source

fn ncols(&self) -> usize

Return the number of columns of the underlying operator

source

fn rank(&self) -> usize

Return the rank of the underlying operator

source

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

Convert to a matrix.

source

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

Compress to SVD.

source

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

Compress the SVD by specifying a target rank.

source

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

Compress the SVD by specifying a relative tolerance.

source

impl SVDTraits for SVD<c32>

type A = Complex<f32>

source

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

source

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

source

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

source

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

source

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

source

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

source

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

Convert to a QR Decomposition.

source

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

source

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 Read more

source

fn nrows(&self) -> usize

Return the number of rows of the underlying operator

source

fn ncols(&self) -> usize

Return the number of columns of the underlying operator

source

fn rank(&self) -> usize

Return the rank of the underlying operator

source

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

Convert to a matrix.

source

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

Compress to SVD.

source

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

Compress the SVD by specifying a target rank.

source

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

Compress the SVD by specifying a relative tolerance.

source

impl SVDTraits for SVD<c64>

type A = Complex<f64>

source

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

source

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

source

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

source

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

source

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

source

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

source

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

Convert to a QR Decomposition.

source

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

source

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 Read more

source

fn nrows(&self) -> usize

Return the number of rows of the underlying operator

source

fn ncols(&self) -> usize

Return the number of columns of the underlying operator

source

fn rank(&self) -> usize

Return the rank of the underlying operator

source

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

Convert to a matrix.

source

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

Compress to SVD.

source

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

Compress the SVD by specifying a target rank.

source

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

Compress the SVD by specifying a relative tolerance.

Auto Trait Implementations

impl<A> RefUnwindSafe for SVD<A> where
A: RefUnwindSafe,
<A as Scalar>::Real: RefUnwindSafe,

impl<A> Send for SVD<A> where
A: Send,
<A as Scalar>::Real: Send,

impl<A> Sync for SVD<A> where
A: Sync,
<A as Scalar>::Real: Sync,

impl<A> Unpin for SVD<A>

impl<A> UnwindSafe for SVD<A> where
A: RefUnwindSafe,
<A as Scalar>::Real: RefUnwindSafe,

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> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct rusty_compression::svd::SVD

Fields

Trait Implementations

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>>

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>>

fn nrows(&self) -> usize

fn ncols(&self) -> usize

fn rank(&self) -> usize

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

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

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

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

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>>

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>>

fn nrows(&self) -> usize

fn ncols(&self) -> usize

fn rank(&self) -> usize

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

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

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

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

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>>

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>>

fn nrows(&self) -> usize

fn ncols(&self) -> usize

fn rank(&self) -> usize

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

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

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

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

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>>

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>>

fn nrows(&self) -> usize

fn ncols(&self) -> usize

fn rank(&self) -> usize

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

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

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

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

Auto Trait Implementations

impl<A> RefUnwindSafe for SVD<A> where A: RefUnwindSafe, <A as Scalar>::Real: RefUnwindSafe,

impl<A> Send for SVD<A> where A: Send, <A as Scalar>::Real: Send,

impl<A> Sync for SVD<A> where A: Sync, <A as Scalar>::Real: Sync,

impl<A> Unpin for SVD<A>

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

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

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

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

impl<A> RefUnwindSafe for SVD<A> where
A: RefUnwindSafe,
<A as Scalar>::Real: RefUnwindSafe,

impl<A> Send for SVD<A> where
A: Send,
<A as Scalar>::Real: Send,

impl<A> Sync for SVD<A> where
A: Sync,
<A as Scalar>::Real: Sync,

impl<A> UnwindSafe for SVD<A> where
A: RefUnwindSafe,
<A as Scalar>::Real: RefUnwindSafe,

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

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

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

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

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

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

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