Enum Grid 

pub enum Grid<Idx>
where
    Idx: RawIndex,
{
    Edge(IndexBase<Idx, EdgeIndex>),
    Vertex(IndexBase<Idx, VertexIndex>),
    Raw(Idx),
}

the Grid enumerate the possible variations of indicies that can be used within the scope of a hypergraph. This entity is useful for enabling “compoite” collections of indicies for iteration, traversal, etc.

Variants

Edge(IndexBase<Idx, EdgeIndex>)

Vertex(IndexBase<Idx, VertexIndex>)

Raw(Idx)

Implementations

impl<Idx> Grid<Idx>

where Idx: RawIndex,

pub const fn is_edge(&self) -> bool

Returns true if the enum is Grid::Edge otherwise false

pub const fn is_vertex(&self) -> bool

Returns true if the enum is Grid::Vertex otherwise false

pub const fn is_raw(&self) -> bool

Returns true if the enum is Grid::Raw otherwise false

Trait Implementations

impl<Idx> Clone for Grid<Idx>

where Idx: RawIndex + Clone,

fn clone(&self) -> Grid<Idx>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Idx> Debug for Grid<Idx>

where Idx: RawIndex + Debug,

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

Formats the value using the given formatter.

impl<'de, Idx> Deserialize<'de> for Grid<Idx>

where Idx: RawIndex + Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Idx> EnumCount for Grid<Idx>

where Idx: RawIndex,

const COUNT: usize = 3usize

impl<'_enum, Idx> From<&'_enum Grid<Idx>> for IndexKind

where Idx: RawIndex,

fn from(val: &'_enum Grid<Idx>) -> IndexKind

Converts to this type from the input type.

impl<Idx> From<Grid<Idx>> for IndexKind

where Idx: RawIndex,

fn from(val: Grid<Idx>) -> IndexKind

Converts to this type from the input type.

impl<Idx> Hash for Grid<Idx>

where Idx: RawIndex + Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Idx> IntoDiscriminant for Grid<Idx>

where Idx: RawIndex,

type Discriminant = IndexKind

Enum listing the same variants as this enum but without any data fields

fn discriminant(&self) -> Self::Discriminant

impl<Idx> Ord for Grid<Idx>

where Idx: RawIndex + Ord,

fn cmp(&self, other: &Grid<Idx>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<Idx> PartialEq for Grid<Idx>

where Idx: RawIndex + PartialEq,

fn eq(&self, other: &Grid<Idx>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Idx> PartialOrd for Grid<Idx>

where Idx: RawIndex + PartialOrd,

fn partial_cmp(&self, other: &Grid<Idx>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Idx> Serialize for Grid<Idx>

where Idx: RawIndex + Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Idx> Copy for Grid<Idx>

where Idx: RawIndex + Copy,

impl<Idx> Eq for Grid<Idx>

where Idx: RawIndex + Eq,

impl<Idx> StructuralPartialEq for Grid<Idx>

where Idx: RawIndex,