Struct extendr_api::prelude::sparse::linalg::qr::simplicial::SimplicialQrRef

pub struct SimplicialQrRef<'a, I, E>
where
    E: Entity,
{
    symbolic: &'a SymbolicSimplicialQr<I>,
    r_col_ptrs: &'a [I],
    r_row_indices: &'a [I],
    r_values: SliceGroup<'a, E>,
    householder_col_ptrs: &'a [I],
    householder_row_indices: &'a [I],
    householder_values: SliceGroup<'a, E>,
    tau_values: SliceGroup<'a, E>,
}

QR factors containing both the symbolic and numeric representations.

Fields

symbolic: &'a SymbolicSimplicialQr<I>

r_col_ptrs: &'a [I]

r_row_indices: &'a [I]

r_values: SliceGroup<'a, E>

householder_col_ptrs: &'a [I]

householder_row_indices: &'a [I]

householder_values: SliceGroup<'a, E>

tau_values: SliceGroup<'a, E>

Implementations

impl<'a, I, E> SimplicialQrRef<'a, I, E>

where I: Index, E: Entity,

pub fn new( symbolic: &'a SymbolicSimplicialQr<I>, r: SparseColMatRef<'a, I, E>, householder: SparseColMatRef<'a, I, E>, tau_values: <<E as Entity>::Group as ForType>::FaerOf<&'a [<E as Entity>::Unit]>, ) -> SimplicialQrRef<'a, I, E>

Creates QR factors from their components.

pub fn symbolic(&self) -> &SymbolicSimplicialQr<I>

Returns the symbolic structure of the QR factorization.

pub fn r_values( self, ) -> <<E as Entity>::Group as ForType>::FaerOf<&'a [<E as Entity>::Unit]>

Returns the numerical values of the factor $R$ of the QR factorization.

pub fn householder_values( self, ) -> <<E as Entity>::Group as ForType>::FaerOf<&'a [<E as Entity>::Unit]>

Returns the numerical values of the Householder factors of the QR factorization.

pub fn tau_values( self, ) -> <<E as Entity>::Group as ForType>::FaerOf<&'a [<E as Entity>::Unit]>

Returns the numerical values of the $T$ factors of the QR factorization.

pub fn solve_in_place_with_conj( &self, conj: Conj, rhs: MatMut<'_, E>, parallelism: Parallelism<'_>, work: MatMut<'_, E>, )

where E: ComplexField,

Solves the equation $\text{Op}(A) x = \text{rhs}$ in the sense of least squares, where $\text{Op}$ is either the identity or the conjugate, depending on the value of conj, and stores the result in the upper part of rhs.

work is a temporary workspace with the same dimensions as rhs.

Trait Implementations

impl<I, E> Clone for SimplicialQrRef<'_, I, E>

where E: Entity,

fn clone(&self) -> SimplicialQrRef<'_, I, E>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, I, E> Debug for SimplicialQrRef<'a, I, E>

where I: Debug, E: Debug + Entity,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<I, E> Copy for SimplicialQrRef<'_, I, E>

where E: Entity,