Struct RandomSelector

pub struct RandomSelector<T> { /* private fields */ }

A selector allowing to randomly select a value from a set of choices, each with an associated weight.

use rand_select::RandomSelector;
let selector = RandomSelector::default()
   .with(1.0, 'A')
   .with(1.5, 'B')
   .with_none(3.0);
let l = selector.select();
// l has half a chance to be None, and is 50% more likely to be 'B' than 'A'

Implementations

impl<T> RandomSelector<T>

pub fn with(self, weight: f64, value: T) -> Self

pub fn with_none(self, weight: f64) -> Self

pub fn with_none_up_to(self, total_weight: f64) -> Self

Complete choices to be None up to the given weight.

This is convenient where all choices set are conventionnaly already normalized:

use rand_select::RandomSelector;
let selector = RandomSelector::default()
   .with(0.1, 'A')
   .with(0.2, 'B')
   .with_none_up_to(1.0);

pub fn select(&self) -> Option<&T>

Select a random value among the provided ones.

pub fn select_with_rng<R: Rng>(&self, r: R) -> Option<&T>

Select a random value among the provided ones, with the generator of your choice.

Trait Implementations

impl<T: Clone> Clone for RandomSelector<T>

fn clone(&self) -> RandomSelector<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Default for RandomSelector<T>

fn default() -> Self

Returns the “default value” for a type.