rusty_compression::qr

Trait QRTraits

Source 
pub trait QRTraits {
    type A: Scalar;


Show 16 methods    // Required methods
    fn column_id(&self) -> Result<ColumnID<Self::A>>;
    fn compute_from(arr: ArrayView2<'_, Self::A>) -> Result<QR<Self::A>>;
    fn compute_from_range_estimate<Op: ConjMatMat<A = Self::A>>(
        range: ArrayView2<'_, Self::A>,
        op: &Op,
    ) -> Result<QR<Self::A>>;
    fn get_q(&self) -> ArrayView2<'_, Self::A>;
    fn get_r(&self) -> ArrayView2<'_, Self::A>;
    fn get_ind(&self) -> ArrayView1<'_, usize>;
    fn get_q_mut(&mut self) -> ArrayViewMut2<'_, Self::A>;
    fn get_r_mut(&mut self) -> ArrayViewMut2<'_, Self::A>;
    fn get_ind_mut(&mut self) -> ArrayViewMut1<'_, usize>;

    // Provided methods
    fn nrows(&self) -> usize { ... }
    fn ncols(&self) -> usize { ... }
    fn rank(&self) -> usize { ... }
    fn to_mat(&self) -> Array2<Self::A> { ... }
    fn compress_qr_rank(&self, max_rank: usize) -> Result<QR<Self::A>> { ... }
    fn compress_qr_tolerance(&self, tol: f64) -> Result<QR<Self::A>> { ... }
    fn compress(&self, compression_type: CompressionType) -> Result<QR<Self::A>> { ... }

}

Required Associated Types§

Source

type A: Scalar

Required Methods§

Source

fn column_id(&self) -> Result<ColumnID<Self::A>>

Compute a column interpolative decomposition from the QR decomposition

Source

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

Compute the QR decomposition from a given array

Source

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

Compute a QR decomposition from a range estimate

§Arguments
  • range: A matrix with orthogonal columns that approximates the range of the operator.
  • op: The underlying operator.
Source

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

Return the Q matrix

Source

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

Return the R matrix

Source

fn get_ind(&self) -> ArrayView1<'_, usize>

Return the index vector

Source

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

Source

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

Source

fn get_ind_mut(&mut self) -> ArrayViewMut1<'_, usize>

Provided Methods§

Source

fn nrows(&self) -> usize

Number of rows

Source

fn ncols(&self) -> usize

Number of columns

Source

fn rank(&self) -> usize

Rank of the QR Decomposition

Source

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

Convert the QR decomposition to a matrix

Source

fn compress_qr_rank(&self, max_rank: usize) -> Result<QR<Self::A>>

Compress by giving a target rank

Source

fn compress_qr_tolerance(&self, tol: f64) -> Result<QR<Self::A>>

Compress by specifying a relative tolerance

Source

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

Compress the QR decomposition by rank or tolerance

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§