extendr_api::prelude::sparse::linalg::cholesky::supernodal

Struct SymbolicSupernodalCholesky

pub struct SymbolicSupernodalCholesky<I>
where
    I: Index,
{
    pub(crate) dimension: usize,
    pub(crate) supernode_postorder: Vec<I>,
    pub(crate) supernode_postorder_inv: Vec<I>,
    pub(crate) descendant_count: Vec<I>,
    pub(crate) supernode_begin: Vec<I>,
    pub(crate) col_ptrs_for_row_indices: Vec<I>,
    pub(crate) col_ptrs_for_values: Vec<I>,
    pub(crate) row_indices: Vec<I>,
    pub(crate) nnz_per_super: Option<Vec<I>>,
}
Expand description

Cholesky factor structure containing its symbolic structure.

Fields§

§dimension: usize§supernode_postorder: Vec<I>§supernode_postorder_inv: Vec<I>§descendant_count: Vec<I>§supernode_begin: Vec<I>§col_ptrs_for_row_indices: Vec<I>§col_ptrs_for_values: Vec<I>§row_indices: Vec<I>§nnz_per_super: Option<Vec<I>>

Implementations§

§

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

pub fn n_supernodes(&self) -> usize

Returns the number of supernodes in the Cholesky factor.

pub fn nrows(&self) -> usize

Returns the number of rows of the Cholesky factor.

pub fn ncols(&self) -> usize

Returns the number of columns of the Cholesky factor.

pub fn len_values(&self) -> usize

Returns the length of the slice that can be used to contain the numerical values of the Cholesky factor.

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

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

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

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

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

Returns the column pointers for row indices of each supernode.

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

Returns the column pointers for numerical values of each supernode.

pub fn row_indices(&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.

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

Returns the symbolic structure of the s’th supernode.

pub fn solve_in_place_req<E>( &self, rhs_ncols: usize, ) -> Result<StackReq, SizeOverflow>
where E: Entity,

Returns the size and alignment of the workspace required to solve the system A×x = rhs.

Trait Implementations§

§

impl<I> Debug for SymbolicSupernodalCholesky<I>
where I: Debug + Index,

§

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.