Struct LatticeLink 

pub struct LatticeLink<const D: usize> { /* private fields */ }

A lattice link, contrary to LatticeLinkCanonical the direction can be negative.

This means that multiple link can be equivalent but does not have the same data and therefore hash (hopefully).

By itself the link does not store data about the lattice. Hence most function require a LatticeCyclic. It also means that there is no guarantee that the object is inside a lattice. You can use modulus over the elements to use inside a lattice.

Implementations

impl<const D: usize> LatticeLink<D>

pub const fn new(from: LatticePoint<D>, dir: Direction<D>) -> Self

Create a link from position from and direction dir.

pub const fn pos(&self) -> &LatticePoint<D>

Get the position of the link.

pub fn pos_mut(&mut self) -> &mut LatticePoint<D>

Get a mutable reference to the position of the link.

pub const fn dir(&self) -> &Direction<D>

Get the direction of the link.

pub fn dir_mut(&mut self) -> &mut Direction<D>

Get a mutable reference to the direction of the link.

pub const fn is_dir_positive(&self) -> bool

Get if the direction of the link is positive.

pub const fn is_dir_negative(&self) -> bool

Get if the direction of the link is negative.

Trait Implementations

impl<const D: usize> Clone for LatticeLink<D>

fn clone(&self) -> LatticeLink<D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const D: usize> Debug for LatticeLink<D>

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

Formats the value using the given formatter.

impl<'de, const D: usize> Deserialize<'de> for LatticeLink<D>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const D: usize> Display for LatticeLink<D>

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

Formats the value using the given formatter.

impl<const D: usize> From<&LatticeLinkCanonical<D>> for LatticeLink<D>

fn from(l: &LatticeLinkCanonical<D>) -> Self

Converts to this type from the input type.

impl<const D: usize> From<LatticeLinkCanonical<D>> for LatticeLink<D>

fn from(l: LatticeLinkCanonical<D>) -> Self

Converts to this type from the input type.

impl<const D: usize> Hash for LatticeLink<D>

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<const D: usize> PartialEq for LatticeLink<D>

fn eq(&self, other: &LatticeLink<D>) -> 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<const D: usize> Serialize for LatticeLink<D>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<const D: usize> Copy for LatticeLink<D>

impl<const D: usize> Eq for LatticeLink<D>

impl<const D: usize> StructuralPartialEq for LatticeLink<D>