Struct Probability

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

Type representing the probability an event.

This struct is just a wrapper around f64 that strictly enforces that the probability lies in \([0, 1]\).

Implementations

impl Probability

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

Construct a probability, checking that the argument lies in \([0, 1]\).

Examples

use rstat::Probability;

// Invalid probabilities:
assert!(Probability::new(1.5).is_err());
assert!(Probability::new(-1.0).is_err());

// Valid probabilities:
assert!(Probability::new(0.0).is_ok());
assert!(Probability::new(0.5).is_ok());
assert!(Probability::new(1.0).is_ok());

pub fn new_unchecked(p: f64) -> Probability

Construct a probability without checking for validity.

pub fn zero() -> Probability

Returns a new Probability with value 0.

pub fn half() -> Probability

Returns a new Probability with value 0.5.

pub fn one() -> Probability

Returns a new Probability with value 1.

pub fn unwrap(self) -> f64

Unwrap the probability and return the internal f64.

Examples

use rstat::Probability;

assert_eq!(Probability::half().unwrap(), 0.5);

pub fn is_valid(&self) -> bool

Returns true if the probability lies in \([0, 1]\).

Examples

use rstat::Probability;

assert!(Probability::new_unchecked(0.5).is_valid());
assert!(!Probability::new_unchecked(10.0).is_valid());

pub fn ln(self) -> f64

Return the natural logarithm of the probability: \(\ln{p}\).

Examples

use rstat::Probability;

assert_eq!(Probability::one().ln(), 0.0);

pub fn log2(self) -> f64

Return the base-2 logarithm of the probability: \(\log_2{p}\).

Examples

use rstat::Probability;

assert_eq!(Probability::half().log2(), -1.0);

pub fn powf(self, e: f64) -> f64

Return the probability raised to the power e: \(p^e\).

Examples

use rstat::Probability;

assert_eq!(Probability::half().powf(2.5), 0.1767766952966369);

pub fn powi(self, e: i32) -> f64

Return the probability raised to the power e: \(p^e\).

Examples

use rstat::Probability;

assert_eq!(Probability::half().powi(2), 0.25);

Trait Implementations

impl<'a, 'b> Add<&'a Probability> for &'b Probability

type Output = Result<Probability, InvalidProbabilityError>

The resulting type after applying the + operator.

fn add( self, other: &'a Probability, ) -> Result<Probability, InvalidProbabilityError>

Performs the + operation.

impl<'a, 'b> Add<&'a Probability> for &'b f64

type Output = f64

The resulting type after applying the + operator.

fn add(self, other: &'a Probability) -> f64

Performs the + operation.

impl<'a> Add<&'a Probability> for Probability

type Output = Result<Probability, InvalidProbabilityError>

The resulting type after applying the + operator.

fn add( self, other: &'a Probability, ) -> Result<Probability, InvalidProbabilityError>

Performs the + operation.

impl<'a> Add<&'a Probability> for f64

type Output = f64

The resulting type after applying the + operator.

fn add(self, other: &'a Probability) -> f64

Performs the + operation.

impl<'a, 'b> Add<&'a f64> for &'b Probability

type Output = f64

The resulting type after applying the + operator.

fn add(self, other: &'a f64) -> f64

Performs the + operation.

impl<'a> Add<&'a f64> for Probability

type Output = f64

The resulting type after applying the + operator.

fn add(self, other: &'a f64) -> f64

Performs the + operation.

impl<'a> Add<Probability> for &'a Probability

type Output = Result<Probability, InvalidProbabilityError>

The resulting type after applying the + operator.

fn add(self, other: Probability) -> Result<Probability, InvalidProbabilityError>

Performs the + operation.

impl<'a> Add<Probability> for &'a f64

type Output = f64

The resulting type after applying the + operator.

fn add(self, other: Probability) -> f64

Performs the + operation.

impl Add<Probability> for f64

type Output = f64

The resulting type after applying the + operator.

fn add(self, other: Probability) -> f64

Performs the + operation.

impl<'a> Add<f64> for &'a Probability

type Output = f64

The resulting type after applying the + operator.

fn add(self, other: f64) -> f64

Performs the + operation.

impl Add<f64> for Probability

type Output = f64

The resulting type after applying the + operator.

fn add(self, other: f64) -> f64

Performs the + operation.

impl Add for Probability

type Output = Result<Probability, InvalidProbabilityError>

The resulting type after applying the + operator.

fn add(self, other: Probability) -> Result<Probability, InvalidProbabilityError>

Performs the + operation.

impl Clone for Probability

fn clone(&self) -> Probability

Returns a copy 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() -> Probability

Returns the “default value” for a type.

impl Display for Probability

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

Formats the value using the given formatter.

impl<'a, 'b> Div<&'a Probability> for &'b Probability

type Output = Result<Probability, InvalidProbabilityError>

The resulting type after applying the / operator.

fn div( self, other: &'a Probability, ) -> Result<Probability, InvalidProbabilityError>

Performs the / operation.

impl<'a, 'b> Div<&'a Probability> for &'b f64

type Output = f64

The resulting type after applying the / operator.

fn div(self, other: &'a Probability) -> f64

Performs the / operation.

impl<'a> Div<&'a Probability> for Probability

type Output = Result<Probability, InvalidProbabilityError>

The resulting type after applying the / operator.

fn div( self, other: &'a Probability, ) -> Result<Probability, InvalidProbabilityError>

Performs the / operation.

impl<'a> Div<&'a Probability> for f64

type Output = f64

The resulting type after applying the / operator.

fn div(self, other: &'a Probability) -> f64

Performs the / operation.

impl<'a, 'b> Div<&'a f64> for &'b Probability

type Output = f64

The resulting type after applying the / operator.

fn div(self, other: &'a f64) -> f64

Performs the / operation.

impl<'a> Div<&'a f64> for Probability

type Output = f64

The resulting type after applying the / operator.

fn div(self, other: &'a f64) -> f64

Performs the / operation.

impl<'a> Div<Probability> for &'a Probability

type Output = Result<Probability, InvalidProbabilityError>

The resulting type after applying the / operator.

fn div(self, other: Probability) -> Result<Probability, InvalidProbabilityError>

Performs the / operation.

impl<'a> Div<Probability> for &'a f64

type Output = f64

The resulting type after applying the / operator.

fn div(self, other: Probability) -> f64

Performs the / operation.

impl Div<Probability> for f64

type Output = f64

The resulting type after applying the / operator.

fn div(self, other: Probability) -> f64

Performs the / operation.

impl<'a> Div<f64> for &'a Probability

type Output = f64

The resulting type after applying the / operator.

fn div(self, other: f64) -> f64

Performs the / operation.

impl Div<f64> for Probability

type Output = f64

The resulting type after applying the / operator.

fn div(self, other: f64) -> f64

Performs the / operation.

impl Div for Probability

type Output = Result<Probability, InvalidProbabilityError>

The resulting type after applying the / operator.

fn div(self, other: Probability) -> Result<Probability, InvalidProbabilityError>

Performs the / operation.

impl From<Probability> for f64

fn from(p: Probability) -> f64

Converts to this type from the input type.

impl<'a, 'b> Mul<&'a Probability> for &'b Probability

type Output = Probability

The resulting type after applying the * operator.

fn mul(self, other: &'a Probability) -> Probability

Performs the * operation.

impl<'a, 'b> Mul<&'a Probability> for &'b f64

type Output = f64

The resulting type after applying the * operator.

fn mul(self, other: &'a Probability) -> f64

Performs the * operation.

impl<'a> Mul<&'a Probability> for Probability

type Output = Probability

The resulting type after applying the * operator.

fn mul(self, other: &'a Probability) -> Probability

Performs the * operation.

impl<'a> Mul<&'a Probability> for f64

type Output = f64

The resulting type after applying the * operator.

fn mul(self, other: &'a Probability) -> f64

Performs the * operation.

impl<'a, 'b> Mul<&'a f64> for &'b Probability

type Output = f64

The resulting type after applying the * operator.

fn mul(self, other: &'a f64) -> f64

Performs the * operation.

impl<'a> Mul<&'a f64> for Probability

type Output = f64

The resulting type after applying the * operator.

fn mul(self, other: &'a f64) -> f64

Performs the * operation.

impl<'a> Mul<Probability> for &'a Probability

type Output = Probability

The resulting type after applying the * operator.

fn mul(self, other: Probability) -> Probability

Performs the * operation.

impl<'a> Mul<Probability> for &'a f64

type Output = f64

The resulting type after applying the * operator.

fn mul(self, other: Probability) -> f64

Performs the * operation.

impl Mul<Probability> for f64

type Output = f64

The resulting type after applying the * operator.

fn mul(self, other: Probability) -> f64

Performs the * operation.

impl<'a> Mul<f64> for &'a Probability

type Output = f64

The resulting type after applying the * operator.

fn mul(self, other: f64) -> f64

Performs the * operation.

impl Mul<f64> for Probability

type Output = f64

The resulting type after applying the * operator.

fn mul(self, other: f64) -> f64

Performs the * operation.

impl Mul for Probability

type Output = Probability

The resulting type after applying the * operator.

fn mul(self, other: Probability) -> Probability

Performs the * operation.

impl Not for &Probability

type Output = Probability

The resulting type after applying the ! operator.

fn not(self) -> Probability

Performs the unary ! operation.

impl Not for Probability

type Output = Probability

The resulting type after applying the ! operator.

fn not(self) -> Probability

Performs the unary ! operation.

impl Param for Probability

type Value = f64

fn value(&self) -> &f64

Returns a reference to the parameter’s value.

fn into_value(self) -> f64

Converts the parameter into it’s value.

fn constraints() -> Constraints<Self::Value>

Returns the constraints associated with this parameter type.

impl PartialEq<f64> for Probability

fn eq(&self, other: &f64) -> 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 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<'a, 'b> Rem<&'a Probability> for &'b Probability

type Output = Result<Probability, InvalidProbabilityError>

The resulting type after applying the % operator.

fn rem( self, other: &'a Probability, ) -> Result<Probability, InvalidProbabilityError>

Performs the % operation.

impl<'a, 'b> Rem<&'a Probability> for &'b f64

type Output = f64

The resulting type after applying the % operator.

fn rem(self, other: &'a Probability) -> f64

Performs the % operation.

impl<'a> Rem<&'a Probability> for Probability

type Output = Result<Probability, InvalidProbabilityError>

The resulting type after applying the % operator.

fn rem( self, other: &'a Probability, ) -> Result<Probability, InvalidProbabilityError>

Performs the % operation.

impl<'a> Rem<&'a Probability> for f64

type Output = f64

The resulting type after applying the % operator.

fn rem(self, other: &'a Probability) -> f64

Performs the % operation.

impl<'a, 'b> Rem<&'a f64> for &'b Probability

type Output = f64

The resulting type after applying the % operator.

fn rem(self, other: &'a f64) -> f64

Performs the % operation.

impl<'a> Rem<&'a f64> for Probability

type Output = f64

The resulting type after applying the % operator.

fn rem(self, other: &'a f64) -> f64

Performs the % operation.

impl<'a> Rem<Probability> for &'a Probability

type Output = Result<Probability, InvalidProbabilityError>

The resulting type after applying the % operator.

fn rem(self, other: Probability) -> Result<Probability, InvalidProbabilityError>

Performs the % operation.

impl<'a> Rem<Probability> for &'a f64

type Output = f64

The resulting type after applying the % operator.

fn rem(self, other: Probability) -> f64

Performs the % operation.

impl Rem<Probability> for f64

type Output = f64

The resulting type after applying the % operator.

fn rem(self, other: Probability) -> f64

Performs the % operation.

impl<'a> Rem<f64> for &'a Probability

type Output = f64

The resulting type after applying the % operator.

fn rem(self, other: f64) -> f64

Performs the % operation.

impl Rem<f64> for Probability

type Output = f64

The resulting type after applying the % operator.

fn rem(self, other: f64) -> f64

Performs the % operation.

impl Rem for Probability

type Output = Result<Probability, InvalidProbabilityError>

The resulting type after applying the % operator.

fn rem(self, other: Probability) -> Result<Probability, InvalidProbabilityError>

Performs the % operation.

impl<'a, 'b> Sub<&'a Probability> for &'b Probability

type Output = Result<Probability, InvalidProbabilityError>

The resulting type after applying the - operator.

fn sub( self, other: &'a Probability, ) -> Result<Probability, InvalidProbabilityError>

Performs the - operation.

impl<'a, 'b> Sub<&'a Probability> for &'b f64

type Output = f64

The resulting type after applying the - operator.

fn sub(self, other: &'a Probability) -> f64

Performs the - operation.

impl<'a> Sub<&'a Probability> for Probability

type Output = Result<Probability, InvalidProbabilityError>

The resulting type after applying the - operator.

fn sub( self, other: &'a Probability, ) -> Result<Probability, InvalidProbabilityError>

Performs the - operation.

impl<'a> Sub<&'a Probability> for f64

type Output = f64

The resulting type after applying the - operator.

fn sub(self, other: &'a Probability) -> f64

Performs the - operation.

impl<'a, 'b> Sub<&'a f64> for &'b Probability

type Output = f64

The resulting type after applying the - operator.

fn sub(self, other: &'a f64) -> f64

Performs the - operation.

impl<'a> Sub<&'a f64> for Probability

type Output = f64

The resulting type after applying the - operator.

fn sub(self, other: &'a f64) -> f64

Performs the - operation.

impl<'a> Sub<Probability> for &'a Probability

type Output = Result<Probability, InvalidProbabilityError>

The resulting type after applying the - operator.

fn sub(self, other: Probability) -> Result<Probability, InvalidProbabilityError>

Performs the - operation.

impl<'a> Sub<Probability> for &'a f64

type Output = f64

The resulting type after applying the - operator.

fn sub(self, other: Probability) -> f64

Performs the - operation.

impl Sub<Probability> for f64

type Output = f64

The resulting type after applying the - operator.

fn sub(self, other: Probability) -> f64

Performs the - operation.

impl<'a> Sub<f64> for &'a Probability

type Output = f64

The resulting type after applying the - operator.

fn sub(self, other: f64) -> f64

Performs the - operation.

impl Sub<f64> for Probability

type Output = f64

The resulting type after applying the - operator.

fn sub(self, other: f64) -> f64

Performs the - operation.

impl Sub for Probability

type Output = Result<Probability, InvalidProbabilityError>

The resulting type after applying the - operator.

fn sub(self, other: Probability) -> Result<Probability, InvalidProbabilityError>

Performs the - operation.

impl<'a> Sum<&'a Probability> for f64

fn sum<I: Iterator<Item = &'a Probability>>(iter: I) -> f64

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Sum<Probability> for f64

fn sum<I: Iterator<Item = Probability>>(iter: I) -> f64

Takes an iterator and generates Self from the elements by “summing up” the items.

impl TryFrom<f64> for Probability

type Error = InvalidProbabilityError

The type returned in the event of a conversion error.

fn try_from(p: f64) -> Result<Self, InvalidProbabilityError>

Performs the conversion.

impl Copy for Probability

impl StructuralPartialEq for Probability