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

Struct SupernodalQrRef

pub struct SupernodalQrRef<'a, I, E>where
    I: Index,
    E: Entity,{
    symbolic: &'a SymbolicSupernodalQr<I>,
    rt_values: SliceGroup<'a, E>,
    householder_values: SliceGroup<'a, E>,
    tau_values: SliceGroup<'a, E>,
    householder_row_indices: &'a [I],
    tau_blocksize: &'a [I],
    householder_nrows: &'a [I],
    householder_ncols: &'a [I],
}

Expand description

QR factors containing both the symbolic and numeric representations.

Fields§

§symbolic: &'a SymbolicSupernodalQr§rt_values: SliceGroup<'a, E>§householder_values: SliceGroup<'a, E>§tau_values: SliceGroup<'a, E>§householder_row_indices: &'a [I]§tau_blocksize: &'a [I]§householder_nrows: &'a [I]§householder_ncols: &'a [I]

Implementations§

§

impl<'a, I, E> SupernodalQrRef<'a, I, E>
where I: Index, E: Entity,

pub unsafe fn new_unchecked( symbolic: &'a SymbolicSupernodalQr, householder_row_indices: &'a [I], tau_blocksize: &'a [I], householder_nrows: &'a [I], householder_ncols: &'a [I], r_values: <<E as Entity>::Group as ForType>::FaerOf<&'a [<E as Entity>::Unit]>, householder_values: <<E as Entity>::Group as ForType>::FaerOf<&'a [<E as Entity>::Unit]>, tau_values: <<E as Entity>::Group as ForType>::FaerOf<&'a [<E as Entity>::Unit]>, ) -> SupernodalQrRef<'a, I, E>

Creates QR factors from their components.

§Safety

The inputs must be the outputs of factorize_supernodal_numeric_qr.

pub fn symbolic(self) -> &'a SymbolicSupernodalQr

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>, stack: PodStack<'_>, )
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 SupernodalQrRef<'_, I, E>
where I: Index, E: Entity,

§

fn clone(&self) -> SupernodalQrRef<'_, 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 SupernodalQrRef<'a, I, E>
where I: Debug + Index, 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 SupernodalQrRef<'_, I, E>
where I: Index, E: Entity,

Auto Trait Implementations§

§

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

§

impl<'a, I, E> RefUnwindSafe for SupernodalQrRef<'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 SupernodalQrRef<'a, I, E>

§

impl<'a, I, E> Sync for SupernodalQrRef<'a, I, E>

§

Struct SupernodalQrRefCopy item path

Fields§

Implementations§

impl<'a, I, E> SupernodalQrRef<'a, I, E>where I: Index, E: Entity,

§Safety

pub fn symbolic(self) -> &'a SymbolicSupernodalQr<I>

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

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

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

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

Trait Implementations§

impl<I, E> Clone for SupernodalQrRef<'_, I, E>where I: Index, E: Entity,

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

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

impl<'a, I, E> Debug for SupernodalQrRef<'a, I, E>where I: Debug + Index, E: Debug + Entity,

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

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

Auto Trait Implementations§

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

impl<'a, I, E> RefUnwindSafe for SupernodalQrRef<'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 SupernodalQrRef<'a, I, E>

impl<'a, I, E> Sync for SupernodalQrRef<'a, I, E>

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

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

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘwhere F: FnOnce(&Self) -> bool,

impl<T> Pointable for T

const ALIGN: usize = _

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Struct SupernodalQrRef

impl<'a, I, E> SupernodalQrRef<'a, I, E>
where I: Index, E: Entity,

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

impl<I, E> Clone for SupernodalQrRef<'_, I, E>
where I: Index, E: Entity,

impl<'a, I, E> Debug for SupernodalQrRef<'a, I, E>
where I: Debug + Index, E: Debug + Entity,

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

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

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

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

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

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,