Struct ProbabilitySet 

pub struct ProbabilitySet<V> { /* private fields */ }

A set of values of type V where each value is associated with a frequency so that a value can be chosen from the set at random with the probability of each value weighted by its frequency.

Implementations

impl<V> ProbabilitySet<V>

pub fn iter(&self) -> impl Iterator<Item = (f32, &V)>

Iterate through all the items in the set and their frequencies.

pub fn len(&self) -> usize

The number of elements in the set.

pub fn is_empty(&self) -> bool

True if the set has no elements.

pub fn clear(&mut self)

Remove the content of the set.

pub fn add(&mut self, frequency: f32, value: V)

Add a value and give it a frequency.

pub fn total_frequency(&self) -> f32

The sum of the frequencies of all the elements of the set. The probability of an element being chosen is the frequency of that element divided by this total.

pub fn average_frequency(&self) -> f32

The mean of the frequencies of all the elements of the set.

pub fn get_random<R>(&self, rng: &mut R) -> Option<&V>

where R: Rng + ?Sized,

Choose a value from the set using the given random number generator. The probability of each element of the set being chosen is the frequency of that element divided by the sum of the frequencies of all elements.

Trait Implementations

impl<V> Clone for ProbabilitySet<V>

where V: Clone,

fn clone(&self) -> ProbabilitySet<V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V> Debug for ProbabilitySet<V>

where V: Debug,

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

Formats the value using the given formatter.

impl<V> Default for ProbabilitySet<V>

fn default() -> ProbabilitySet<V>

Returns the “default value” for a type.