Struct vegas_lattice::Vertex

pub struct Vertex { /* private fields */ }

Represents a vertex in a lattice.

The source and target fields are the indices of the sites that the vertex connects. The delta field is a tuple of the displacements of the target site from the source site. A delta of (0, 0, 1) would mean that the target site is one unit along the z axis from the source site.

For a simple cubic lattice the source and target for all the vertices would be the same, 0. While delta would be (1, 0, 0), (0, 1, 0), (0, 0, 1). Those 3 vertices would connect all the sites in the lattice.

Examples

Here is an example of how to create a vertex and access its fields:

use vegas_lattice::Vertex;

let vertex = Vertex::new(0, 1, (0, 0, 1));
assert_eq!(vertex.source(), 0);
assert_eq!(vertex.target(), 1);
assert_eq!(vertex.delta(), (0, 0, 1));

Here’s how to move a vertex along an axis:

use vegas_lattice::{Vertex, Axis};

let vertex = Vertex::new(0, 1, (0, 0, 1)).move_along(Axis::Z, 1, 2, 3);
assert_eq!(vertex.source(), 2);
assert_eq!(vertex.target(), 5);
assert_eq!(vertex.delta(), (0, 0, 0));

Implementations

impl Vertex

pub fn new(source: usize, target: usize, delta: (i32, i32, i32)) -> Self

Creates a new vertex with the given source and target

pub fn source(&self) -> usize

Returns the source of the vertex

pub fn target(&self) -> usize

Returns the target of the vertex

pub fn delta(&self) -> (i32, i32, i32)

Returns the delta of the vertex

pub fn delta_along(&self, axis: Axis) -> i32

Returns the delta of the vertex alogn a given axis

pub fn with_tags(self, tags: Vec<&str>) -> Self

Chagges the tags of the vertex

pub fn move_along( self, axis: Axis, amount: usize, nsites: usize, limit: usize ) -> Self

Move the vertex along a given axis by a given amount

The only reason you would want to move a vertex along an axis is to grow a lattice along that axis. That’s why we’re going to need to know the parameters of how much the lattice is going to grow by. This function takes in the nsites, the number of sites in the original lattice, and the limit, the total number of units the lattice will be grown by. The vertex will be changed assuming that the new number of sites will be limit * nsites.

Warning

This function is so complicated it should be private!

Arguments

• axis - The axis along which to move the vertex
• amount - The number of units to move the vertex
• nsites - The number of sites in the original lattice
• limit - The total number of units the lattice will be grown by

pub fn reindex(self, index: &[usize]) -> Self

Re-index the vertex

Trait Implementations

impl Clone for Vertex

fn clone(&self) -> Vertex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vertex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Vertex

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for Vertex

type Err = Error

The associated error which can be returned from parsing.

fn from_str(source: &str) -> Result<Vertex, Self::Err>

Parses a string s to return a value of this type.

impl Serialize for Vertex

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Tagged for Vertex

fn tags(&self) -> Option<&Vec<String>>

Returns the tags of the object

fn has_tag(&self, tag: String) -> bool

Returns true if the object has the given tag