rusty_compression::qr

Trait LQTraits

Source 
pub trait LQTraits {
    type A: Scalar;


Show 15 methods    // Required methods
    fn get_q(&self) -> ArrayView2<'_, Self::A>;
    fn get_l(&self) -> ArrayView2<'_, Self::A>;
    fn get_ind(&self) -> ArrayView1<'_, usize>;
    fn get_q_mut(&mut self) -> ArrayViewMut2<'_, Self::A>;
    fn get_l_mut(&mut self) -> ArrayViewMut2<'_, Self::A>;
    fn get_ind_mut(&mut self) -> ArrayViewMut1<'_, usize>;
    fn compute_from(arr: ArrayView2<'_, Self::A>) -> Result<LQ<Self::A>>;
    fn row_id(&self) -> Result<RowID<Self::A>>;

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

}
Expand description

Traits for the LQ Decomposition

Required Associated Types§

Source

type A: Scalar

Required Methods§

Source

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

Return the Q matrix

Source

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

Return the L 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_l_mut(&mut self) -> ArrayViewMut2<'_, Self::A>

Source

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

Source

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

Compute the LQ decomposition from a given array

Source

fn row_id(&self) -> Result<RowID<Self::A>>

Compute a row interpolative decomposition from the LQ decomposition

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

Source

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

Convert the LQ decomposition to a matrix

Source

fn compress_lq_rank(&self, max_rank: usize) -> Result<LQ<Self::A>>

Compress by giving a target rank

Source

fn compress_lq_tolerance(&self, tol: f64) -> Result<LQ<Self::A>>

Compress by specifying a relative tolerance

Source

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

Compress the LQ 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§