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

Struct 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>, }
Expand description

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. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

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

impl<I, E> Copy for SimplicialQrRef<'_, I, E>
where E: Entity,

Auto Trait Implementations§

§

impl<'a, I, E> Freeze for SimplicialQrRef<'a, I, E>
where <<E as Entity>::Group as ForCopyType>::FaerOfCopy<*const [<E as Entity>::Unit]>: Freeze,

§

impl<'a, I, E> RefUnwindSafe for SimplicialQrRef<'a, I, E>
where <<E as Entity>::Group as ForCopyType>::FaerOfCopy<*const [<E as Entity>::Unit]>: RefUnwindSafe, I: RefUnwindSafe,

§

impl<'a, I, E> Send for SimplicialQrRef<'a, I, E>
where I: Sync,

§

impl<'a, I, E> Sync for SimplicialQrRef<'a, I, E>
where I: Sync,

§

impl<'a, I, E> Unpin for SimplicialQrRef<'a, I, E>
where <<E as Entity>::Group as ForCopyType>::FaerOfCopy<*const [<E as Entity>::Unit]>: Unpin,

§

impl<'a, I, E> UnwindSafe for SimplicialQrRef<'a, I, E>
where <<E as Entity>::Group as ForCopyType>::FaerOfCopy<*const [<E as Entity>::Unit]>: UnwindSafe, I: 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.