faer::sparse::linalg::qr::supernodal

Struct SymbolicSupernodalHouseholder

pub struct SymbolicSupernodalHouseholder<I> { /* private fields */ }

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)$$

Implementations§

Source §

impl<I: Index> SymbolicSupernodalHouseholder

Source

pub fn nrows(&self) -> usize

returns the number of rows of the householder factors

Source

pub fn n_supernodes(&self) -> usize

returns the number of supernodes in the symbolic $QR$

Source

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

returns the column pointers for the numerical values of the householder factors

Source

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

returns the column pointers for the numerical values of the $t$ factors

Source

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

returns the column pointers for the row indices of the householder factors

Source

pub fn len_householder_val(&self) -> usize

returns the length of the slice that can be used to contain the numerical values of the householder factors

Source

pub fn len_householder_row_idx(&self) -> usize

returns the length of the slice that can be used to contain the row indices of the householder factors

Source

pub fn len_tau_val(&self) -> usize

returns the length of the slice that can be used to contain the numerical values of the $t$ factors

Trait Implementations§

Source §

impl<I: Debug> Debug for SymbolicSupernodalHouseholder

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for SymbolicSupernodalHouseholder
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> ByRef<T> for T

Source §

fn by_ref(&self) -> &T

Source §

impl<T> DistributionExt for T
where T: ?Sized,

Source §

fn rand<T>(&self, rng: &mut (impl ?Sized + Rng)) -> T
where Self: Distribution<T>,

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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

Source §