Struct lattice_qcd_rs::lattice::LatticeLinkCanonical

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

A canonical link of a lattice. It contain a position and a direction.

The direction should always be positive. 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.

This object can be used to safely index in a std::collections::HashMap

Implementations

impl<const D: usize> LatticeLinkCanonical<D>

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

Try create a LatticeLinkCanonical. If the dir is negative it fails.

To guaranty creating an element see LatticeCyclic::link_canonical. The creation of an element this ways does not guaranties that the element is inside a lattice.

Example

let l = LatticeLinkCanonical::new(LatticePoint::new([0; 4].into()), DirectionEnum::XNeg.into());
assert_eq!(l, None);

let l = LatticeLinkCanonical::new(LatticePoint::new([0; 4].into()), DirectionEnum::XPos.into());
assert!(l.is_some());

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

Position of the link.

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

Get a mutable reference on the position of the link.

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

Direction of the link.

pub fn set_dir(&mut self, dir: Direction<D>)

Set the direction to dir

Example

let mut lattice_link_canonical =
    LatticeLinkCanonical::new(LatticePoint::new([0; 4].into()), DirectionEnum::YPos.into())
        .ok_or(ImplementationError::OptionWithUnexpectedNone)?;
lattice_link_canonical.set_dir(DirectionEnum::XPos.into());
assert_eq!(*lattice_link_canonical.dir(), DirectionEnum::XPos.into());

Panic

panic if a negative direction is given.

lattice_link_canonical.set_dir(DirectionEnum::XNeg.into()); // Panics !

pub fn set_dir_positive(&mut self, dir: Direction<D>)

Set the direction using positive direction. i.e. if a direction -x is passed the direction assigned will be +x.

This is equivalent to link.set_dir(dir.to_positive()).

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<'de, const D: usize> Deserialize<'de> for LatticeLinkCanonical<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 LatticeLinkCanonical<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 LatticeLinkCanonical<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> LatticeElementToIndex<D> for LatticeLinkCanonical<D>

fn to_index(&self, l: &LatticeCyclic<D>) -> usize

Given a lattice return an index from the element

impl<const D: usize> PartialEq<LatticeLinkCanonical<D>> for LatticeLinkCanonical<D>

fn eq(&self, other: &LatticeLinkCanonical<D>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<const D: usize> Serialize for LatticeLinkCanonical<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 LatticeLinkCanonical<D>

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

impl<const D: usize> StructuralEq for LatticeLinkCanonical<D>

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