Struct extendr_api::prelude::sparse::linalg::cholesky::simplicial::EliminationTreeRef
pub struct EliminationTreeRef<'a, I>where
I: Index,{
pub(crate) inner: &'a [<I as Index>::Signed],
}
Expand description
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,
impl<'a, I> EliminationTreeRef<'a, I>where
I: Index,
pub fn into_inner(self) -> &'a [<I as Index>::Signed]
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>
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>
impl<'a, I> Clone for EliminationTreeRef<'a, I>
§fn clone(&self) -> EliminationTreeRef<'a, I>
fn clone(&self) -> EliminationTreeRef<'a, I>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read more§impl<'a, I> Debug for EliminationTreeRef<'a, I>
impl<'a, I> Debug for EliminationTreeRef<'a, I>
impl<'a, I> Copy for EliminationTreeRef<'a, I>
Auto Trait Implementations§
impl<'a, I> Freeze for EliminationTreeRef<'a, I>
impl<'a, I> RefUnwindSafe for EliminationTreeRef<'a, I>
impl<'a, I> Send for EliminationTreeRef<'a, I>
impl<'a, I> Sync for EliminationTreeRef<'a, I>
impl<'a, I> Unpin for EliminationTreeRef<'a, I>
impl<'a, I> UnwindSafe for EliminationTreeRef<'a, I>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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