Enum lattice_qcd_rs::utils::Sign

pub enum Sign {
    Negative,
    Positive,
    Zero,
}

Represent a sign.

Variants

Negative

Strictly negative number (non zero)

Positive

Strictly positive number ( non zero)

Zero

Zero (or very close to zero)

Implementations

impl Sign

pub const fn to_f64(self) -> f64

return a f64 form the sign (-1_f64, 0_f64, 1_f64).

pub fn sign_f64(f: f64) -> Self

Get the sign form a f64.

If the value is very close to zero but not quite the sing will nonetheless be Sign::Zero. If f is NaN the sing will be Sign::Zero.

pub const fn to_i8(self) -> i8

Convert the sign to an i8.

pub const fn sign_i8(n: i8) -> Self

Get the sign of the given i8

pub const fn sign_from_diff(a: usize, b: usize) -> Self

Returns the sign of a - b, where a and b are usize

Trait Implementations

impl Clone for Sign

fn clone(&self) -> Sign

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sign

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

Formats the value using the given formatter.

impl Default for Sign

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Sign

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

Deserialize this value from the given Serde deserializer.

impl Display for Sign

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

Formats the value using the given formatter.

impl From<Sign> for f64

fn from(s: Sign) -> f64

Converts to this type from the input type.

impl From<Sign> for i8

fn from(s: Sign) -> i8

Converts to this type from the input type.

impl From<f64> for Sign

fn from(f: f64) -> Sign

Converts to this type from the input type.

impl From<i8> for Sign

fn from(i: i8) -> Sign

Converts to this type from the input type.

impl Hash for Sign

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 Mul<Sign> for Sign

type Output = Sign

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self

Performs the * operation.

impl MulAssign<Sign> for Sign

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for Sign

type Output = Sign

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for Sign

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Sign> for Sign

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

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 Sign

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 Sign

impl Eq for Sign

impl StructuralEq for Sign

impl StructuralPartialEq for Sign