SymbolicSupernodalCholesky

faer::sparse::linalg::cholesky::supernodal

Struct SymbolicSupernodalCholesky 

Source 
pub struct SymbolicSupernodalCholesky<I> { /* private fields */ }
Expand description

cholesky factor structure containing its symbolic structure

Implementations§

Source§

impl<I: Index> SymbolicSupernodalCholesky<I>

Source

pub fn n_supernodes(&self) -> usize

returns the number of supernodes in the cholesky factor

Source

pub fn nrows(&self) -> usize

returns the number of rows of the cholesky factor

Source

pub fn ncols(&self) -> usize

returns the number of columns of the cholesky factor

Source

pub fn len_val(&self) -> usize

returns the length of the slice that can be used to contain the numerical values of the cholesky factor

Source

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

returns a slice of length self.n_supernodes() containing the beginning index of each supernode

Source

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

returns a slice of length self.n_supernodes() containing the past-the-end index of each

Source

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

returns the column pointers for row indices of each supernode

Source

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

returns the column pointers for numerical values of each supernode

Source

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

returns the row indices of the cholesky factor

§note

note that the row indices of each supernode do not contain those of the block diagonal part

Source

pub fn supernode(&self, s: usize) -> SymbolicSupernodeRef<'_, I>

returns the symbolic structure of the s’th supernode

Source

pub fn solve_in_place_scratch<T: ComplexField>( &self, rhs_ncols: usize, par: Par, ) -> StackReq

returns the size and alignment of the workspace required to solve the system $A x = rhs$

Trait Implementations§

Source§

impl<I: Debug> Debug for SymbolicSupernodalCholesky<I>

Source§

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

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

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V