Struct lattice_qcd_rs::lattice::LatticePoint

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

Represents point on a (any) lattice.

Implementations

impl<const D: usize> LatticePoint<D>

pub const fn new(data: SVector<usize, D>) -> Self

Create a new lattice point.

It can be outside a lattice.

pub fn new_zero() -> Self

Create a point at the origin

pub fn from_fn<F>(f: F) -> Selfwhere F: FnMut(usize) -> usize,

Create a point using the closure generate elements with the index as input.

See nalgebra::base::Matrix::from_fn.

pub const fn len(&self) -> usize

Number of elements in LatticePoint. This is D.

pub const fn is_empty(&self) -> bool

Return if LatticePoint contain no data. True when the dimension is 0, false otherwise.

pub fn iter( &self ) -> impl Iterator<Item = &usize> + ExactSizeIterator + FusedIterator

Get an iterator on the data.

pub fn iter_mut( &mut self ) -> impl Iterator<Item = &mut usize> + ExactSizeIterator + FusedIterator

Get an iterator on the data as mutable.

pub const fn as_svector(&self) -> &SVector<usize, D>

Get the point as as nalgebra::SVector<usize, D>

Example

let max = point.as_svector().max();
let min = point.as_ref().min();

pub fn as_svector_mut(&mut self) -> &mut SVector<usize, D>

Get the point as a mut ref to nalgebra::SVector<usize, D>

Example

point.as_svector_mut()[2] = 2;
point.as_mut()[0] = 1;

Trait Implementations

impl<const D: usize> AsMut<Matrix<usize, Const<D>, Const<1>, ArrayStorage<usize, D, 1>>> for LatticePoint<D>

fn as_mut(&mut self) -> &mut SVector<usize, D>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<const D: usize> AsRef<Matrix<usize, Const<D>, Const<1>, ArrayStorage<usize, D, 1>>> for LatticePoint<D>

fn as_ref(&self) -> &SVector<usize, D>

Converts this type into a shared reference of the (usually inferred) input type.

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

fn clone(&self) -> LatticePoint<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 LatticePoint<D>

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

Formats the value using the given formatter.

impl<const D: usize> Default for LatticePoint<D>

fn default() -> Self

Returns the “default value” for a type.

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

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

Formats the value using the given formatter.

impl<const D: usize> From<LatticePoint<D>> for [usize; D]where SVector<usize, D>: Into<[usize; D]>,

fn from(data: LatticePoint<D>) -> [usize; D]

Converts to this type from the input type.

impl<T, const D: usize> From<T> for LatticePoint<D>where SVector<usize, D>: From<T>,

fn from(data: T) -> Self

Converts to this type from the input type.

impl<const D: usize> Hash for LatticePoint<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> Index<usize> for LatticePoint<D>

fn index(&self, pos: usize) -> &Self::Output

Get the element at position pos

Panic

Panics if the position is out of bound

let point = LatticePoint::new([0; 4].into());
let _ = point[4];

type Output = usize

The returned type after indexing.

impl<const D: usize> IndexMut<usize> for LatticePoint<D>

fn index_mut(&mut self, pos: usize) -> &mut Self::Output

Get the element at position pos

Panic

Panics if the position is out of bound

let mut point = LatticePoint::new([0; 4].into());
point[4] += 1;

impl<'a, const D: usize> IntoIterator for &'a LatticePoint<D>

type IntoIter = <&'a Matrix<usize, Const<D>, Const<1>, ArrayStorage<usize, D, 1>> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

type Item = &'a usize

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, const D: usize> IntoIterator for &'a mut LatticePoint<D>

type IntoIter = <&'a mut Matrix<usize, Const<D>, Const<1>, ArrayStorage<usize, D, 1>> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

type Item = &'a mut usize

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<const D: usize> LatticeElementToIndex<D> for LatticePoint<D>

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

Given a lattice return an index from the element

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

fn eq(&self, other: &LatticePoint<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> PartialOrd<LatticePoint<D>> for LatticePoint<D>

fn partial_cmp(&self, other: &LatticePoint<D>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

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

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

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

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