Enum rpick::ConfigCategory

pub enum ConfigCategory {
    Even {
        choices: Vec<String>,
    },
    Gaussian {
        stddev_scaling_factor: f64,
        choices: Vec<String>,
    },
    Lottery {
        choices: Vec<LotteryChoice>,
    },
    Weighted {
        choices: Vec<WeightedChoice>,
    },
}

A category of items that can be chosen from.

Each variant of this Enum maps to one of the supported algorithms.

Variants

Even

The Even variant picks from its choices with even distribution.

Attributes

• choices - The list of choices to pick from.

Fields of Even

choices: Vec<String>

Gaussian

The Gaussian variant uses a Gaussian distribution to prefer choices near the beginning of the list of choices over those at the end. Once a choice has been accepted, it is moved to the end of the list.

Attributes

• stddev_scaling_factor - This is used to derive the standard deviation; the standard deviation is the length of the list of choices, divided by this scaling factor.
• choices - The list of choices to pick from.

Fields of Gaussian

stddev_scaling_factor: f64choices: Vec<String>

Lottery

The Lottery variant uses a weighted distribution to pick items, with each items chances being tied to how many tickets it has. When a choice is accepted, that choice's ticket count is set to 0, and every choice not chosen receives its weight in additional tickets.

Attributes

• choices - The list of choices to pick from.

Fields of Lottery

choices: Vec<LotteryChoice>

Weighted

The Weighted variant is a simple weighted distribution.

Attributes

• choices - The list of choices to pick from.

Fields of Weighted

choices: Vec<WeightedChoice>

Trait Implementations

impl PartialEq<ConfigCategory> for ConfigCategory

fn eq(&self, other: &ConfigCategory) -> bool

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

fn ne(&self, other: &ConfigCategory) -> bool

This method tests for !=.

impl Serialize for ConfigCategory

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for ConfigCategory

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.