Struct Probability

pub struct Probability<T: Num>(pub T);

An independent probability.

This represents some probability of some abstract, isolated event occuring. Note that the even have to be isolated (independent of any other event) for the operations to be correct. As such, you shouldn’t do calculations with conditional events. Stronger methods needs to be used for this.

This newtype simply wraps some numeral type and provides it with operations:

• & for independent and.
• | for independent or.
• ^ for independent mutual exclusivity.
• ! for inverse probability.

Tuple Fields

0: T

Implementations

impl<T: Num + PartialOrd> Probability<T>

pub fn certain() -> Probability<T>

The probability representing a “almost certain” condition.

“Almost certain” (a.c.) should not be equated with “certain”, because something can be practically certain, but not impossible to fail. For example, pick a random natural number from an uniform distribution. Not picking a specific number would be almost certain, but it is not impossible, because an argument for impossibility could be applied to any number.

For practical purposes, though, there is no difference between certain and almost certain.

pub fn never() -> Probability<T>

The inverse of an “almost certain” condition (almost never).

pub fn half(self) -> Probability<T>

Half the probability.

pub fn fifty() -> Probability<T>

A fifty-fifty probability (0.5).

pub fn disjointed_or(self, rhs: Probability<T>) -> Probability<T>

‘or’ for mutually exclusive events

Trait Implementations

impl<T: Num + PartialOrd> BitAnd for Probability<T>

type Output = Probability<T>

The resulting type after applying the & operator.

fn bitand(self, rhs: Probability<T>) -> Probability<T>

Performs the & operation.

impl<T: Num + Clone + PartialOrd> BitOr for Probability<T>

type Output = Probability<T>

The resulting type after applying the | operator.

fn bitor(self, rhs: Probability<T>) -> Probability<T>

Performs the | operation.

impl<T: Num + Clone + PartialOrd> BitXor for Probability<T>

type Output = Probability<T>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Probability<T>) -> Probability<T>

Performs the ^ operation.

impl<T: Clone + Num> Clone for Probability<T>

fn clone(&self) -> Probability<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Num> Debug for Probability<T>

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

Formats the value using the given formatter.

impl<T: Num + PartialOrd> Not for Probability<T>

type Output = Probability<T>

The resulting type after applying the ! operator.

fn not(self) -> Probability<T>

Performs the unary ! operation.

impl<T: Ord + Num> Ord for Probability<T>

fn cmp(&self, other: &Probability<T>) -> 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<T: PartialEq + Num> PartialEq for Probability<T>

fn eq(&self, other: &Probability<T>) -> 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<T: PartialOrd + Num> PartialOrd for Probability<T>

fn partial_cmp(&self, other: &Probability<T>) -> 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<T: Copy + Num> Copy for Probability<T>

impl<T: Eq + Num> Eq for Probability<T>

impl<T: Num> StructuralPartialEq for Probability<T>