Struct AliasTable

pub struct AliasTable<T, F> { /* private fields */ }

An alias table, which uses floating point probabilities of type F and table entries of type T.

Implementations

impl<T, F> AliasTable<T, F>

where F: PartialOrd + SampleRange,

pub fn pick<'a, R: Rng>(&'a self, rng: &mut R) -> &'a T

Pick a random element from the distribution. Samples from the RNG using ind_sample only.

pub fn iter<R: Rng>(&self, rng: R) -> AliasTableIterator<'_, T, F, R>

Given an RNG, produce an iterator that picks random element from the distribution by calling pick repeatedly with the given RNG.

Trait Implementations

impl<T, F> Debug for AliasTable<T, F>

where F: Debug,

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

Formats the value using the given formatter.

impl<'a, T, F> FromIterator<(T, F)> for AliasTable<T, F>

where F: Float + NumCast + One + SampleRange + Sum<F> + Zero + 'a,

fn from_iter<I: IntoIterator<Item = (T, F)>>(iter: I) -> Self

Construct an alias table from an iterator. Expects a tuple, where the left-hand element is the distribution’s value, and the right-hand element is the value’s weight in the distribution.

impl<'a, T, F> IntoIterator for &'a AliasTable<T, F>

where F: Sized + PartialOrd + SampleRange,

fn into_iter(self) -> Self::IntoIter

Produces an iterator that picks random element from the distribution by calling calling pick repeatedly with the thread’s RNG.

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = AliasTableIterator<'a, T, F, ThreadRng>

Which kind of iterator are we turning this into?