Struct EliminationTreeRef 

pub struct EliminationTreeRef<'a, I: Index> { /* private fields */ }

reference to a slice containing the cholesky factor’s elimination tree

the elimination tree (or elimination forest, in the general case) is a structure representing the relationship between the columns of the cholesky factor, and the way how earlier columns contribute their sparsity pattern to later columns of the factor

Implementations

impl<'a, I: Index> EliminationTreeRef<'a, I>

pub fn len(&self) -> usize

dimension of the original matrix

pub fn into_inner(self) -> &'a [I::Signed]

returns the raw elimination tree

a value can be either nonnegative to represent the index of the parent of a given node, or -1 to signify that it has no parent

pub unsafe fn from_inner(inner: &'a [I::Signed]) -> Self

creates an elimination tree reference from the underlying array

safety

the elimination tree must come from an array that was previously filled with prefactorize_symbolic_cholesky

Trait Implementations

impl<'a, I: Clone + Index> Clone for EliminationTreeRef<'a, I>

where I::Signed: Clone,

fn clone(&self) -> EliminationTreeRef<'a, I>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, I: Debug + Index> Debug for EliminationTreeRef<'a, I>

where I::Signed: Debug,

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

Formats the value using the given formatter.

impl<'a, I: Copy + Index> Copy for EliminationTreeRef<'a, I>

where I::Signed: Copy,