extendr_api::prelude::sparse::linalg::qr

Struct 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: usize

Implementations§

§

impl<I> SymbolicQr<I>
where I: Index,

pub fn nrows(&self) -> usize

Number of rows of $A$.

pub fn ncols(&self) -> usize

Number of columns of $A$.

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

Returns the length of the slice needed to store the symbolic indices of the QR decomposition.

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,

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,

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,

Computes a numerical QR factorization of A.

Trait Implementations§

§

impl<I> Debug for SymbolicQr<I>
where I: Debug + Index,

§

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

Formats the value using the given formatter. Read more

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

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.