wicker 0.1.0

Weighted probability picker for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

# Wicker


It's often helpful to have weighted probabilities.
This crate offers the [`WeightedPicker`] struct that serves as a sort of weighted bag;
you can give it entries with various weights, and then randomly sample them.

This is the way Minecraft loot tables work, if this sounds familiar.

The algorithm used is [Vose's Alias Method](https://www.keithschwarz.com/darts-dice-coins/)
(scroll to the bottom), which to be honest I absolutely do not understand.
But it has O(n) creation and O(1) selection, so sounds good to me.

A [`WeightedPicker`] is static; you can't edit the probabilities after you've created it due
to the algorithm used. However, you can edit each associated value after creation through the
[`WeightedPicker::pick`] method, if you wanted to do that for some reason.

## Sample Usage


```rust
# use cogs_gamedev::chance::WeightedPicker;

let picker = WeightedPicker::new(vec![
    ("common", 10.0),
    ("uncommon", 5.0),
    ("rare", 2.0),
    ("legendary", 1.0),
    ("mythic", 0.1),
]);

let mut rng = rand::thread_rng();
for _ in 0..10 {
    println!("- {}", picker.get(&mut rng));
}
```

A sample output:
- legendary
- rare
- uncommon
- common
- common
- rare
- uncommon
- common
- common
- uncommon