Struct EliminationTreeRef

pub struct EliminationTreeRef<'a, I>
where
    I: Index,
{
    pub(crate) inner: &'a [<I as Index>::Signed],
}

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.

Fields

inner: &'a [<I as Index>::Signed]

Implementations

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

where I: Index,

pub fn into_inner(self) -> &'a [<I as Index>::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 as Index>::Signed], ) -> EliminationTreeRef<'a, I>

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 for EliminationTreeRef<'a, I>

where I: Clone + Index, <I as Index>::Signed: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, I> Debug for EliminationTreeRef<'a, I>

where I: Debug + Index, <I as Index>::Signed: Debug,

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

Formats the value using the given formatter.

impl<'a, I> Copy for EliminationTreeRef<'a, I>

where I: Copy + Index, <I as Index>::Signed: Copy,