Struct genevo::random::WeightedDistribution

pub struct WeightedDistribution<'a, T> where
    T: 'a + AsScalar,  { /* fields omitted */ }

The WeightedDistribution is used to select values proportional to their weighted values.

The values in a WeightedDistribution must have a scalar representation. Thus their types must implement the genetic::AsScalar trait. The weights of the values are calculated from their scalar representation.

Methods

impl<'a, T> WeightedDistribution<'a, T> where
    T: 'a + AsScalar, 

pub fn from_scalar_values(values: &'a [T]) -> Self

Constructs a new instance of WeightedDistribution for the given slice of values.

pub fn select(&self, pointer: f64) -> usize

Selects a value proportional to its weight and returns its index.

The pointer must be a float between 0 und the sum of the weights of all values. Usually the pointer is chosen uniformly at random.

pub fn sum(&self) -> f64

Returns the sum of the weights of all values in this WeightedDistribution instance.

The sum is calculated from the scalar values of the slice that was used to create this WeightedDistribution instance.

pub fn value(&self, index: usize) -> &T

Returns a reference to the value at the given index.

Trait Implementations

impl<'a, T: PartialEq> PartialEq<WeightedDistribution<'a, T>> for WeightedDistribution<'a, T> where
    T: 'a + AsScalar, 

fn eq(&self, other: &WeightedDistribution<'a, T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &WeightedDistribution<'a, T>) -> bool

This method tests for !=.

impl<'a, T: Clone> Clone for WeightedDistribution<'a, T> where
    T: 'a + AsScalar, 

fn clone(&self) -> WeightedDistribution<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for WeightedDistribution<'a, T> where
    T: 'a + AsScalar, 

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

Formats the value using the given formatter.