WinningProbability

hopr_internal_types::tickets

Struct WinningProbability

pub struct WinningProbability(/* private fields */);

Expand description

Represents a ticket-winning probability.

It holds the modified IEEE-754 representation but behaves like a reduced precision float. It intentionally does not implement Ord or Eq, as it can be either approximately compared or lexicographically compared.

Implementations§

impl WinningProbability

pub const ALWAYS: Self

100% winning probability

pub const EPSILON: f64 = 1.0E-8f64

pub const NEVER: Self

0% winning probability.

pub fn as_luck(&self) -> u64

Converts winning probability to an unsigned integer (luck).

pub fn as_encoded(&self) -> EncodedWinProb

Convenience function to convert to internal probability representation.

pub fn as_f64(&self) -> f64

Convert probability to a float.

pub fn try_from_f64(win_prob: f64) -> Result<Self>

Tries to get probability from a float.

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

Performs approximate comparison up to Self::EPSILON.

pub fn approx_eq(&self, other: &Self) -> bool

Performs approximate equality comparison up to Self::EPSILON.

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

Performs lexicographical comparison of the luck values.

pub fn lex_eq(&self, other: &Self) -> bool

Performs lexicographical equality comparison of the luck values.

pub fn min(&self, other: &Self) -> Self

Gets the minimum of two winning probabilities.

pub fn max(&self, other: &Self) -> Self

Gets the maximum of two winning probabilities.

Trait Implementations§

impl AsRef<[u8]> for WinningProbability

fn as_ref(&self) -> &[u8] ⓘ

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

impl BytesRepresentable for WinningProbability

const SIZE: usize = 7usize

Size of the encoded byte array.

fn into_boxed(self) -> Box<[u8]>

Convenience function to copy this type’s binary representation into a Box.

impl Clone for WinningProbability

fn clone(&self) -> WinningProbability

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for WinningProbability

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

Formats the value using the given formatter. Read more

impl Default for WinningProbability

fn default() -> Self

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for WinningProbability

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

Deserialize this value from the given Serde deserializer. Read more

impl Display for WinningProbability

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

Formats the value using the given formatter. Read more

impl<'a> From<&'a [u8; 7]> for WinningProbability

fn from(value: &'a EncodedWinProb) -> Self

Converts to this type from the input type.

impl From<[u8; 7]> for WinningProbability

fn from(value: EncodedWinProb) -> Self

Converts to this type from the input type.

impl From<WinningProbability> for EncodedWinProb

fn from(value: WinningProbability) -> Self

Converts to this type from the input type.

impl From<WinningProbability> for f64

fn from(value: WinningProbability) -> Self

Converts to this type from the input type.

impl From<u64> for WinningProbability

fn from(value: u64) -> Self

Converts to this type from the input type.

impl FromStr for WinningProbability

type Err = CoreTypesError

The associated error which can be returned from parsing.

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

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

impl Hash for WinningProbability

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq<[u8; 7]> for WinningProbability

fn eq(&self, other: &EncodedWinProb) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

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

impl PartialEq<WinningProbability> for f64

fn eq(&self, other: &WinningProbability) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

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

impl PartialEq<f64> for WinningProbability

fn eq(&self, other: &f64) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

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

impl Serialize for WinningProbability

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

Serialize this value into the given Serde serializer. Read more

impl<'a> TryFrom<&'a [u8]> for WinningProbability

type Error = GeneralError

The type returned in the event of a conversion error.

fn try_from(value: &'a [u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<f64> for WinningProbability

type Error = CoreTypesError

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for WinningProbability

Auto Trait Implementations§

impl Freeze for WinningProbability

impl RefUnwindSafe for WinningProbability

impl Send for WinningProbability

impl Sync for WinningProbability

impl Unpin for WinningProbability

impl UnwindSafe for WinningProbability

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToHex for T
where T: BytesRepresentable,

fn to_hex(&self) -> String

Hexadecimal representation of this type.

fn from_hex(str: &str) -> Result<T, GeneralError>

Tries to parse the type from the hexadecimal representation.

impl<T> ToHex for T
where T: AsRef<[u8]>,

fn encode_hex<U>(&self) -> U
where U: FromIterator<char>,

Encode the hex strict representing self into the result. Lower case letters are used (e.g. f9b4ca)

fn encode_hex_upper<U>(&self) -> U
where U: FromIterator<char>,

Encode the hex strict representing self into the result. Upper case letters are used (e.g. F9B4CA)

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,