Struct Bernoulli 

pub struct Bernoulli { /* private fields */ }

A Bernoulli distribution with a single success probability.

Implementations

impl Bernoulli

pub const fn new(success: Probability) -> Self

Creates a Bernoulli model from a validated success probability.

Examples found in repository

examples/basic_usage.rs (line 7)

fn main() -> Result<(), use_probability::ProbabilityError> {
    let rain = Probability::from_fraction(1, 4)?;
    let traffic = Probability::try_new(0.5)?;
    let either_delay = independent_union(rain, traffic);
    let commute = Bernoulli::new(rain);

    assert!((either_delay.value() - 0.625).abs() < 1.0e-12);
    assert_eq!(commute.failure_probability(), Probability::try_new(0.75)?);
    assert!((commute.variance() - 0.1875).abs() < 1.0e-12);

    Ok(())
}

pub const fn success_probability(&self) -> Probability

Returns the success probability.

pub const fn failure_probability(&self) -> Probability

Returns the failure probability.

Examples found in repository

examples/basic_usage.rs (line 10)

fn main() -> Result<(), use_probability::ProbabilityError> {
    let rain = Probability::from_fraction(1, 4)?;
    let traffic = Probability::try_new(0.5)?;
    let either_delay = independent_union(rain, traffic);
    let commute = Bernoulli::new(rain);

    assert!((either_delay.value() - 0.625).abs() < 1.0e-12);
    assert_eq!(commute.failure_probability(), Probability::try_new(0.75)?);
    assert!((commute.variance() - 0.1875).abs() < 1.0e-12);

    Ok(())
}

pub const fn mean(&self) -> f64

Returns the mean of the Bernoulli model.

pub fn variance(&self) -> f64

Returns the variance of the Bernoulli model.

Examples found in repository

examples/basic_usage.rs (line 11)

fn main() -> Result<(), use_probability::ProbabilityError> {
    let rain = Probability::from_fraction(1, 4)?;
    let traffic = Probability::try_new(0.5)?;
    let either_delay = independent_union(rain, traffic);
    let commute = Bernoulli::new(rain);

    assert!((either_delay.value() - 0.625).abs() < 1.0e-12);
    assert_eq!(commute.failure_probability(), Probability::try_new(0.75)?);
    assert!((commute.variance() - 0.1875).abs() < 1.0e-12);

    Ok(())
}

pub const fn pmf(&self, success: bool) -> Probability

Returns the probability mass for success.

Trait Implementations

impl Clone for Bernoulli

fn clone(&self) -> Bernoulli

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bernoulli

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

Formats the value using the given formatter.

impl PartialEq for Bernoulli

fn eq(&self, other: &Bernoulli) -> 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 Copy for Bernoulli

impl StructuralPartialEq for Bernoulli