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

Struct SymbolicSupernodalHouseholder

pub struct SymbolicSupernodalHouseholder<I> {
    col_ptrs_for_row_indices: Vec<I>,
    col_ptrs_for_tau_values: Vec<I>,
    col_ptrs_for_values: Vec<I>,
    super_etree: Vec<I>,
    max_blocksize: Vec<I>,
    nrows: usize,
}
Expand description

Symbolic structure of the Householder reflections that compose $Q$,

such that: $$ Q = (I - H_1 T_1^{-1} H_1^H) \cdot (I - H_2 T_2^{-1} H_2^H) \dots (I - H_k T_k^{-1} H_k^H)$$

Fields§

§col_ptrs_for_row_indices: Vec<I>§col_ptrs_for_tau_values: Vec<I>§col_ptrs_for_values: Vec<I>§super_etree: Vec<I>§max_blocksize: Vec<I>§nrows: usize

Implementations§

§

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

pub fn nrows(&self) -> usize

Returns the number of rows of the Householder factors.

pub fn n_supernodes(&self) -> usize

Returns the number of supernodes in the symbolic QR.

pub fn col_ptrs_for_householder_values(&self) -> &[I]

Returns the column pointers for the numerical values of the Householder factors.

pub fn col_ptrs_for_tau_values(&self) -> &[I]

Returns the column pointers for the numerical values of the $T$ factors.

pub fn col_ptrs_for_householder_row_indices(&self) -> &[I]

Returns the column pointers for the row indices of the Householder factors.

pub fn len_householder_values(&self) -> usize

Returns the length of the slice that can be used to contain the numerical values of the Householder factors.

pub fn len_householder_row_indices(&self) -> usize

Returns the length of the slice that can be used to contain the row indices of the Householder factors.

pub fn len_tau_values(&self) -> usize

Returns the length of the slice that can be used to contain the numerical values of the $T$ factors.

Trait Implementations§

§

impl<I> Debug for SymbolicSupernodalHouseholder<I>
where I: Debug,

§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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.