Struct Probability 

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

Probability for a sampled bit to be true.

Implementations

impl Probability

pub const unsafe fn new_unchecked(x: f64) -> Self

Safety

This function is safe if the given value is within range [0,1].

impl Probability

pub fn new(value: f64) -> Result<Self, InvalidProbabilityError>

Return a new ‘Probability’ if given a valid value.

impl Probability

pub fn into_inner(self) -> f64

Unwrap ‘Probability’ into inner value.

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

fn default() -> Self

Returns the “default value” for a type.

impl Display for Probability

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

Formats the value using the given formatter.

impl From<Probability> for f64

fn from(original: Probability) -> Self

Converts to this type from the input type.

impl From<ProbabilityThreshold> for Probability

fn from(x: ProbabilityThreshold) -> Self

Converts to this type from the input type.

impl FromStr for Probability

type Err = ProbabilityFromStrError

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.

impl LowerBounded for Probability

fn min_value() -> Self

Returns the smallest finite number this type can represent

impl Ord for Probability

fn cmp(&self, other: &Self) -> 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 TryFrom<Probability> for ProbabilityThreshold

type Error = InvalidProbabilityThresholdError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<f64> for Probability

type Error = InvalidProbabilityError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl UpperBounded for Probability

fn max_value() -> Self

Returns the largest finite number this type can represent

impl Copy for Probability

impl Eq for Probability

impl StructuralPartialEq for Probability