Struct rusty_compression::qr::QR

source · [−]

pub struct QR<A: Scalar> {
    pub q: Array2<A>,
    pub r: Array2<A>,
    pub ind: Array1<usize>,
}

Fields

q: Array2<A>

The Q matrix from the QR Decomposition

r: Array2<A>

The R matrix from the QR Decomposition

ind: Array1<usize>

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

Trait Implementations

source

impl QRTraits for QR<f32>

type A = f32

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 compute_from(arr: ArrayView2<'_, Self::A>) -> Result<QR<Self::A>>

Compute the QR decomposition from a given array

source

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

Return the index vector

source

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

Compute a column interpolative decomposition from the QR decomposition

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

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

source

impl QRTraits for QR<f64>

type A = f64

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 compute_from(arr: ArrayView2<'_, Self::A>) -> Result<QR<Self::A>>

Compute the QR decomposition from a given array

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>

source

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

Compute a column interpolative decomposition from the QR decomposition

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

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

source

impl QRTraits for QR<c32>

type A = Complex<f32>

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 compute_from(arr: ArrayView2<'_, Self::A>) -> Result<QR<Self::A>>

Compute the QR decomposition from a given array

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>

source

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

Compute a column interpolative decomposition from the QR decomposition

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

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

source

impl QRTraits for QR<c64>

type A = Complex<f64>

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 compute_from(arr: ArrayView2<'_, Self::A>) -> Result<QR<Self::A>>

Compute the QR decomposition from a given array

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>

source

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

Compute a column interpolative decomposition from the QR decomposition

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

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

Auto Trait Implementations

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

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

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

impl<A> Unpin for QR<A>

impl<A> UnwindSafe for QR<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,

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::qr::QR

Fields

Trait Implementations

impl QRTraits for QR<f32>

type A = f32

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

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

fn compute_from(arr: ArrayView2<'_, Self::A>) -> Result<QR<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>

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

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

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

impl QRTraits for QR<f64>

type A = f64

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

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

fn compute_from(arr: ArrayView2<'_, Self::A>) -> Result<QR<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>

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

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

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

impl QRTraits for QR<c32>

type A = Complex<f32>

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

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

fn compute_from(arr: ArrayView2<'_, Self::A>) -> Result<QR<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>

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

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

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

impl QRTraits for QR<c64>

type A = Complex<f64>

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

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

fn compute_from(arr: ArrayView2<'_, Self::A>) -> Result<QR<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>

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

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

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

Auto Trait Implementations

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

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

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

impl<A> Unpin for QR<A>

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

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

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

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

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

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