Enum nalgebra_sparse::SparseEntry
source · [−]pub enum SparseEntry<'a, T> {
NonZero(&'a T),
Zero,
}Expand description
An entry in a sparse matrix.
Sparse matrices do not store all their entries explicitly. Therefore, entry (i, j) in the matrix can either be a reference to an explicitly stored element, or it is implicitly zero.
Variants
NonZero(&'a T)
The entry is a reference to an explicitly stored element.
Note that the naming here is a misnomer: The element can still be zero, even though it is explicitly stored (a so-called “explicit zero”).
Zero
The entry is implicitly zero, i.e. it is not explicitly stored.
Implementations
sourceimpl<'a, T: Clone + Zero> SparseEntry<'a, T>
impl<'a, T: Clone + Zero> SparseEntry<'a, T>
sourcepub fn into_value(self) -> T
pub fn into_value(self) -> T
Returns the value represented by this entry.
Either clones the underlying reference or returns zero if the entry is not explicitly stored.
Trait Implementations
sourceimpl<'a, T: Debug> Debug for SparseEntry<'a, T>
impl<'a, T: Debug> Debug for SparseEntry<'a, T>
sourceimpl<'a, T: PartialEq> PartialEq<SparseEntry<'a, T>> for SparseEntry<'a, T>
impl<'a, T: PartialEq> PartialEq<SparseEntry<'a, T>> for SparseEntry<'a, T>
sourcefn eq(&self, other: &SparseEntry<'a, T>) -> bool
fn eq(&self, other: &SparseEntry<'a, T>) -> bool
impl<'a, T: Eq> Eq for SparseEntry<'a, T>
impl<'a, T> StructuralEq for SparseEntry<'a, T>
impl<'a, T> StructuralPartialEq for SparseEntry<'a, T>
Auto Trait Implementations
impl<'a, T> RefUnwindSafe for SparseEntry<'a, T>where
T: RefUnwindSafe,
impl<'a, T> Send for SparseEntry<'a, T>where
T: Sync,
impl<'a, T> Sync for SparseEntry<'a, T>where
T: Sync,
impl<'a, T> Unpin for SparseEntry<'a, T>
impl<'a, T> UnwindSafe for SparseEntry<'a, T>where
T: RefUnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read morefn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.