Struct extendr_api::prelude::sparse::linalg::qr::SymbolicQr
pub struct SymbolicQr<I>where
I: Index,{
raw: SymbolicQrRaw<I>,
col_perm_fwd: Vec<I>,
col_perm_inv: Vec<I>,
A_nnz: usize,
}Expand description
The symbolic structure of a sparse QR decomposition.
Fields§
§raw: SymbolicQrRaw<I>§col_perm_fwd: Vec<I>§col_perm_inv: Vec<I>§A_nnz: usizeImplementations§
§impl<I> SymbolicQr<I>where
I: Index,
impl<I> SymbolicQr<I>where
I: Index,
pub fn col_perm(&self) -> PermRef<'_, I>
pub fn col_perm(&self) -> PermRef<'_, I>
Returns the fill-reducing column permutation that was computed during symbolic analysis.
pub fn len_indices(&self) -> usize
pub fn len_indices(&self) -> usize
Returns the length of the slice needed to store the symbolic indices of the QR decomposition.
pub fn len_values(&self) -> usize
pub fn len_values(&self) -> usize
Returns the length of the slice needed to store the numerical values of the QR decomposition.
pub fn solve_in_place_req<E>(
&self,
rhs_ncols: usize,
parallelism: Parallelism<'_>,
) -> Result<StackReq, SizeOverflow>where
E: Entity,
pub fn solve_in_place_req<E>(
&self,
rhs_ncols: usize,
parallelism: Parallelism<'_>,
) -> Result<StackReq, SizeOverflow>where
E: Entity,
Returns the size and alignment of the workspace required to solve the system $Ax = \text{rhs}$ in the sense of least squares.
pub fn factorize_numeric_qr_req<E>(
&self,
parallelism: Parallelism<'_>,
) -> Result<StackReq, SizeOverflow>where
E: Entity,
pub fn factorize_numeric_qr_req<E>(
&self,
parallelism: Parallelism<'_>,
) -> Result<StackReq, SizeOverflow>where
E: Entity,
Computes the required workspace size and alignment for a numerical QR factorization.
pub fn factorize_numeric_qr<'out, E>(
&'out self,
indices: &'out mut [I],
values: <<E as Entity>::Group as ForType>::FaerOf<&'out mut [<E as Entity>::Unit]>,
A: SparseColMatRef<'_, I, E>,
parallelism: Parallelism<'_>,
stack: PodStack<'_>,
) -> QrRef<'out, I, E>where
E: ComplexField,
pub fn factorize_numeric_qr<'out, E>(
&'out self,
indices: &'out mut [I],
values: <<E as Entity>::Group as ForType>::FaerOf<&'out mut [<E as Entity>::Unit]>,
A: SparseColMatRef<'_, I, E>,
parallelism: Parallelism<'_>,
stack: PodStack<'_>,
) -> QrRef<'out, I, E>where
E: ComplexField,
Computes a numerical QR factorization of A.
Trait Implementations§
Auto Trait Implementations§
impl<I> Freeze for SymbolicQr<I>
impl<I> RefUnwindSafe for SymbolicQr<I>where
I: RefUnwindSafe,
impl<I> Send for SymbolicQr<I>
impl<I> Sync for SymbolicQr<I>
impl<I> Unpin for SymbolicQr<I>where
I: Unpin,
impl<I> UnwindSafe for SymbolicQr<I>where
I: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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