Struct Probability 

pub struct Probability { /* private fields */ }

Fixed-point probability stored as basis points from 0 to 10_000.

Implementations

impl Probability

pub const ZERO: Self

Probability 0.0.

pub const ONE: Self

Probability 1.0.

pub const fn from_basis_points(basis_points: u16) -> Option<Self>

Creates a probability from basis points, where 10_000 means certainty.

pub fn from_ratio(numerator: u64, denominator: u64) -> Option<Self>

Creates a probability from a ratio, rounded to the nearest basis point.

pub const fn basis_points(self) -> u16

Returns the fixed-point probability in basis points.

pub const fn complement(self) -> Self

Returns 1 - self.

Trait Implementations

impl Clone for Probability

fn clone(&self) -> Probability

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Probability

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

Formats the value using the given formatter.

impl Ord for Probability

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Probability

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

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

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 PartialOrd for Probability

fn partial_cmp(&self, other: &Probability) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Probability

impl Eq for Probability

impl StructuralPartialEq for Probability