Enum lattice_qcd_rs::lattice::DirectionEnum

pub enum DirectionEnum {
    XPos,
    XNeg,
    YPos,
    YNeg,
    ZPos,
    ZNeg,
    TPos,
    TNeg,
}

Represent a cardinal direction

Variants

XPos

Positive x direction.

XNeg

Negative x direction.

YPos

Positive y direction.

YNeg

Negative y direction.

ZPos

Positive z direction.

ZNeg

Negative z direction.

TPos

Positive t direction.

TNeg

Negative t direction.

Implementations

impl DirectionEnum

pub const DIRECTIONS: [Self; 8] = _

List all directions.

pub const DIRECTIONS_SPACE: [Self; 6] = _

List all spatial directions.

pub const POSITIVES: [Self; 4] = _

List of all positives directions.

pub const POSITIVES_SPACE: [Self; 3] = _

List spatial positive direction.

pub fn to_vector(self, a: f64) -> Vector4<Real>

Convert the direction into a vector of norm a;

pub const fn to_unit_vector(self) -> Vector4<Real>

Convert the direction into a vector of norm 1;

pub const fn is_positive(self) -> bool

Get if the position is positive.

Example

assert_eq!(DirectionEnum::XPos.is_positive(), true);
assert_eq!(DirectionEnum::TPos.is_positive(), true);
assert_eq!(DirectionEnum::YNeg.is_positive(), false);

pub const fn is_negative(self) -> bool

Get if the position is Negative. see DirectionEnum::is_positive

pub fn from_vector(v: &Vector4<Real>) -> Self

Find the direction the vector point the most. For a zero vector return DirectionEnum::XPos.

Example

assert_eq!(
    DirectionEnum::from_vector(&nalgebra::Vector4::new(1_f64, 0_f64, 0_f64, 0_f64)),
    DirectionEnum::XPos
);
assert_eq!(
    DirectionEnum::from_vector(&nalgebra::Vector4::new(0_f64, -1_f64, 0_f64, 0_f64)),
    DirectionEnum::YNeg
);
assert_eq!(
    DirectionEnum::from_vector(&nalgebra::Vector4::new(0.5_f64, 1_f64, 0_f64, 2_f64)),
    DirectionEnum::TPos
);

pub const fn to_positive(self) -> Self

Return the positive direction associated, for example -x gives +x and +x gives +x.

Example

assert_eq!(DirectionEnum::XNeg.to_positive(), DirectionEnum::XPos);
assert_eq!(DirectionEnum::YPos.to_positive(), DirectionEnum::YPos);

pub const fn to_index(self) -> usize

Get a index associated to the direction.

Example

assert_eq!(DirectionEnum::XPos.to_index(), 0);
assert_eq!(DirectionEnum::XNeg.to_index(), 0);
assert_eq!(DirectionEnum::YPos.to_index(), 1);
assert_eq!(DirectionEnum::YNeg.to_index(), 1);
assert_eq!(DirectionEnum::ZPos.to_index(), 2);
assert_eq!(DirectionEnum::ZNeg.to_index(), 2);
assert_eq!(DirectionEnum::TPos.to_index(), 3);
assert_eq!(DirectionEnum::TNeg.to_index(), 3);

Trait Implementations

impl Clone for DirectionEnum

fn clone(&self) -> DirectionEnum

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DirectionEnum

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

Formats the value using the given formatter.

impl Default for DirectionEnum

Return DirectionEnum::XPos

fn default() -> Self

Return DirectionEnum::XPos

impl<'de> Deserialize<'de> for DirectionEnum

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DirectionList for DirectionEnum

fn directions() -> &'static [Self]

List all directions.

fn positive_directions() -> &'static [Self]

List all positive directions.

impl Display for DirectionEnum

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

Formats the value using the given formatter.

impl From<&DirectionEnum> for Direction<4>

fn from(d: &DirectionEnum) -> Self

Converts to this type from the input type.

impl From<&DirectionEnum> for Vector4<Real>

Return DirectionEnum::to_unit_vector.

fn from(d: &DirectionEnum) -> Self

Converts to this type from the input type.

impl From<&DirectionEnum> for usize

Return DirectionEnum::to_index.

fn from(d: &DirectionEnum) -> Self

Converts to this type from the input type.

impl From<&Matrix<f64, Const<4>, Const<1>, ArrayStorage<f64, 4, 1>>> for DirectionEnum

Return DirectionEnum::from_vector.

fn from(v: &Vector4<Real>) -> Self

Converts to this type from the input type.

impl From<DirectionEnum> for Direction<4>

fn from(d: DirectionEnum) -> Self

Converts to this type from the input type.

impl From<DirectionEnum> for Vector4<Real>

Return DirectionEnum::to_unit_vector.

fn from(d: DirectionEnum) -> Self

Converts to this type from the input type.

impl From<DirectionEnum> for usize

Return DirectionEnum::to_index.

fn from(d: DirectionEnum) -> Self

Converts to this type from the input type.

impl From<Matrix<f64, Const<4>, Const<1>, ArrayStorage<f64, 4, 1>>> for DirectionEnum

Return DirectionEnum::from_vector.

fn from(v: Vector4<Real>) -> Self

Converts to this type from the input type.

impl Hash for DirectionEnum

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 Neg for &DirectionEnum

type Output = &DirectionEnum

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Neg for DirectionEnum

Return the negative of a direction

Example

assert_eq!(-DirectionEnum::XNeg, DirectionEnum::XPos);
assert_eq!(-DirectionEnum::YPos, DirectionEnum::YNeg);

type Output = DirectionEnum

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq<DirectionEnum> for DirectionEnum

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

fn partial_cmp(&self, other: &Self) -> 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 Serialize for DirectionEnum

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

Serialize this value into the given Serde serializer.

impl Copy for DirectionEnum

impl Eq for DirectionEnum

impl StructuralEq for DirectionEnum

impl StructuralPartialEq for DirectionEnum