Struct Probability 

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

Probability as f64 in the range 0.0..=1.0.

Use this for rates, weights, and sampling. For a 0..=100 percentage use PercentFloat; for an integer percentage use Percent.

Implementations

impl Probability

pub const MIN: f64 = 0.0

Minimum allowed probability.

pub const MAX: f64 = 1.0

Maximum allowed probability.

pub fn new(value: f64) -> PrimitiveResult<Self>

Creates a Probability. Returns Invalid if value is not finite or is outside 0.0..=1.0.

pub fn get(self) -> f64

Returns the probability value.

pub fn complement(self) -> Self

Returns the complementary probability, 1.0 - p. Always valid because the complement of a value in 0.0..=1.0 is itself in 0.0..=1.0.

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

impl Debug for Probability

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

Formats the value using the given formatter.

impl Display for Probability

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

Formats the value using the given formatter.

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

impl TryFrom<f64> for Probability

type Error = PrimitiveError

The type returned in the event of a conversion error.

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

Performs the conversion.