Struct Dist 

pub struct Dist {
    pub outcomes: Vec<(Value, f64)>,
    pub missing: f64,
}

Fields

outcomes: Vec<(Value, f64)>

Sorted by value, each value once, every weight positive.

missing: f64

Probability not represented by outcomes: a tail cut off to keep the support finite, or weight a simulate left unresolved. Drawing counts it as unresolved.

Implementations

impl Dist

pub fn point(v: Value) -> Dist

pub fn from_pairs(pairs: Vec<(Value, f64)>, missing: f64) -> Dist

Build from (value, weight) pairs in any order, whose weights add up to 1 - missing; equal values are merged.

The weights are rescaled to add up to exactly that, which removes the rounding of the sums that produced them: six sixths of d6 > 0 are 0.9999999999999999, but the distribution is certainly true. Without this, a certain condition would leave a branch of weight 1e-16.

pub fn into_value(self) -> Value

pub fn uniform(values: Vec<Value>) -> Dist

pub fn bernoulli(p: f64) -> Dist

true with probability p.

pub fn dice(count: u32, sides: u32, budget: &mut Budget) -> OpResult<Dist>

The sum of count dice with sides sides.

pub fn binomial(n: u64, p: f64, budget: &mut Budget) -> OpResult<Dist>

pub fn poisson(rate: f64, budget: &mut Budget) -> OpResult<Dist>

pub fn geometric(p: f64, budget: &mut Budget) -> OpResult<Dist>

Number of tries up to and including the first success.

pub fn pool(count: u32, die: &Dist, budget: &mut Budget) -> OpResult<Dist>

The dice of count rolls of die, sorted from highest to lowest.

pub fn total(&self) -> f64

pub fn truth(&self) -> Option<(f64, f64)>

For a distribution of facts: the probabilities of true and false.

pub fn mean(&self) -> Option<f64>

The mean of the resolved outcomes.

pub fn variance(&self) -> Option<f64>

pub fn sd(&self) -> Option<f64>

pub fn quantile(&self, q: f64) -> Option<Value>

Quantile in storage order. Language queries first build a population in language order, which can differ for nested mixed numeric values.

Trait Implementations

impl Clone for Dist

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dist

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

Formats the value using the given formatter.

impl Eq for Dist

impl Hash for Dist

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Dist

fn cmp(&self, other: &Dist) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Dist

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Dist

fn partial_cmp(&self, other: &Dist) -> 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.