rusty_compression::qr

Struct LQ

Source 
pub struct LQ<A: Scalar> {
    pub l: Array2<A>,
    pub q: Array2<A>,
    pub ind: Array1<usize>,
}

Fields§

§l: Array2<A>

The Q matrix from the LQ Decomposition

§q: Array2<A>

The Q matrix from the LQ Decomposition

§ind: Array1<usize>

An index array. If ind[j] = k then the jth row of L * Q is identical to the kth row of the original matrix A.

Trait Implementations§

Source§

impl LQTraits for LQ<c32>

Source§

type A = Complex<f32>

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

impl LQTraits for LQ<c64>

Source§

type A = Complex<f64>

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

impl LQTraits for LQ<f32>

Source§

type A = f32

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

impl LQTraits for LQ<f64>

Source§

type A = f64

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

Auto Trait Implementations§

§

impl<A> Freeze for LQ<A>

§

impl<A> RefUnwindSafe for LQ<A>
where A: RefUnwindSafe,

§

impl<A> Send for LQ<A>
where A: Send,

§

impl<A> Sync for LQ<A>
where A: Sync,

§

impl<A> Unpin for LQ<A>

§

impl<A> UnwindSafe for LQ<A>
where A: 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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V