Struct Distribution

pub struct Distribution { /* private fields */ }

A computed distribution for a bounded dice expression. (“bounded”: does not support exploding dice.)

Implementations

impl Distribution

pub fn probability(&self, value: isize) -> Ratio<usize>

Give the probability of this value occurring in this distribution.

pub fn probability_f64(&self, value: isize) -> f64

pub fn total(&self) -> usize

Report the total number of occurrences in this expression, i.e. the number of possible rolls (rather than the number of distinct values).

pub fn occurrences(&self) -> Occurrences<'_>

Iterator over (value, occurrences) tuples in this distribution. Reports values with nonzero occurrence in ascending order of value.

pub fn min(&self) -> isize

The minimum value with nonzero occurrence in this distribution.

pub fn max(&self) -> isize

The minimum value with nonzero occurrence in this distribution (note: inclusive)

pub fn mean(&self) -> f64

The average value (expected value) from this distribution.

Trait Implementations

impl Add<&Distribution> for &Distribution

type Output = Distribution

The resulting type after applying the + operator.

fn add(self, rhs: &Distribution) -> Self::Output

Performs the + operation.

impl Add for Distribution

type Output = Distribution

The resulting type after applying the + operator.

fn add(self, rhs: Distribution) -> Self::Output

Performs the + operation.

impl Clone for Distribution

fn clone(&self) -> Distribution

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Distribution

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

Formats the value using the given formatter.

impl Neg for &Distribution

type Output = Distribution

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Neg for Distribution

type Output = Distribution

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Distribution

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

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

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

impl Eq for Distribution

impl StructuralPartialEq for Distribution