Struct Probability 

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

A probability in the closed unit interval [0, 1], valid by construction.

A Probability can never hold a NaN, an infinity, a negative, or a value above one: every constructor enforces 0.0 <= p <= 1.0 (a NaN/Inf fails the comparison). As a result the silent all-false-mask degeneracy of u.lower_elem(p) / rng < p on a bad rate is unrepresentable wherever a Probability is held.

Construct with new for literals (panics on an invalid value) or try_new for runtime data (returns ProbabilityError). Deserialize routes through try_new via TryFrom, so a rate loaded from a file cannot deserialize into an out-of-range Probability.

Implementations

impl Probability

pub const fn new(p: f32) -> Self

Builds a probability from a compile-time-known value, panicking on an invalid one.

This is the constructor for literals and Defaults — the bad value is right at the call site, mirroring the documented builder-setter panic exception of ADR 0026. Prefer try_new for any value derived from runtime or user-supplied data.

Panics

Panics when p is outside [0, 1] (including NaN or infinite).

pub fn try_new(p: f32) -> Result<Self, ProbabilityError>

Builds a probability from a runtime / user-supplied value.

Errors

Returns ProbabilityError when p is outside [0, 1] (including NaN or infinite).

pub const fn get(self) -> f32

The wrapped probability, guaranteed to lie in [0, 1].

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<'de> Deserialize<'de> for Probability

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Probability> for f32

fn from(p: Probability) -> Self

Converts to this type from the input type.

impl PartialEq for Probability

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Probability

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Probability

impl TryFrom<f32> for Probability

type Error = ProbabilityError

The type returned in the event of a conversion error.

fn try_from(p: f32) -> Result<Self, Self::Error>

Performs the conversion.