WinningProbability

hopr_api::chain

Struct WinningProbability 

Source 
pub struct WinningProbability(/* private fields */);
Expand description

Represents a ticket winning probability.

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

Implementations§

Source§

impl WinningProbability

Source

pub const ALWAYS: WinningProbability

100% winning probability

Source

pub const EPSILON: f64 = 1.0E-8f64

Source

pub const NEVER: WinningProbability

0% winning probability.

Source

pub fn as_luck(&self) -> u64

Converts winning probability to an unsigned integer (luck).

Source

pub fn as_encoded(&self) -> [u8; 7]

Convenience function to convert to internal probability representation.

Source

pub fn as_f64(&self) -> f64

Convert probability to a float.

Source

pub fn try_from_f64(win_prob: f64) -> Result<WinningProbability, CoreTypesError>

Tries to get probability from a float.

Source

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

Performs approximate comparison up to Self::EPSILON.

Source

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

Performs approximate equality comparison up to Self::EPSILON.

Source

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

Gets the minimum of two winning probabilities.

Source

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

Gets the maximum of two winning probabilities.

Trait Implementations§

Source§

impl AsRef<[u8]> for WinningProbability

Source§

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

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

impl BytesRepresentable for WinningProbability

Source§

const SIZE: usize = 7usize

Size of the encoded byte array.
Source§

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

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

impl Clone for WinningProbability

Source§

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
Source§

impl Debug for WinningProbability

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for WinningProbability

Source§

fn default() -> WinningProbability

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

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for WinningProbability

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn from(value: &'a [u8; 7]) -> WinningProbability

Converts to this type from the input type.
Source§

impl From<[u8; 7]> for WinningProbability

Source§

fn from(value: [u8; 7]) -> WinningProbability

Converts to this type from the input type.
Source§

impl From<WinningProbability> for [u8; 7]

Source§

fn from(value: WinningProbability) -> [u8; 7]

Converts to this type from the input type.
Source§

impl From<u64> for WinningProbability

Source§

fn from(value: u64) -> WinningProbability

Converts to this type from the input type.
Source§

impl PartialEq<f64> for WinningProbability

Source§

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.
Source§

impl Serialize for WinningProbability

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

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

Source§

type Error = GeneralError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<f64> for WinningProbability

Source§

type Error = CoreTypesError

The type returned in the event of a conversion error.
Source§

fn try_from( value: f64, ) -> Result<WinningProbability, <WinningProbability as TryFrom<f64>>::Error>

Performs the conversion.
Source§

impl Copy for WinningProbability

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

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
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

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
Source§

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> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

fn to_hex(&self) -> String

Hexadecimal representation of this type.
Source§

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

Tries to parse the type from the hexadecimal representation.
Source§

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

Source§

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)
Source§

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> ToHex for T
where T: AsRef<[u8]>,

§

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

👎Deprecated: use ToHexExt instead
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>,

👎Deprecated: use ToHexExt instead
Encode the hex strict representing self into the result. Upper case letters are used (e.g. F9B4CA).
§

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

§

fn encode_hex(&self) -> String

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

fn encode_hex_upper(&self) -> String

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

fn encode_hex_with_prefix(&self) -> String

Encode the hex strict representing self into the result with prefix 0x. Lower case letters are used (e.g. 0xf9b4ca).
§

fn encode_hex_upper_with_prefix(&self) -> String

Encode the hex strict representing self into the result with prefix 0X. Upper case letters are used (e.g. 0xF9B4CA).
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
§

impl<T> ToStringFallible for T
where T: Display,

§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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<'de, T> BorrowedRpcObject<'de> for T
where T: RpcBorrow<'de> + RpcSend,

Source§

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

§

impl<'de, T> RpcBorrow<'de> for T
where T: Deserialize<'de> + Debug + Send + Sync + Unpin,

§

impl<T> RpcObject for T
where T: RpcSend + RpcRecv,

§

impl<T> RpcRecv for T
where T: DeserializeOwned + Debug + Send + Sync + Unpin + 'static,

§

impl<T> RpcSend for T
where T: Serialize + Clone + Debug + Send + Sync + Unpin,