random-pick 1.0.1

Pick an element from a slice randomly by given weights.
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

Random Pick
====================

[![Build Status](https://travis-ci.org/magiclen/random-pick.svg?branch=master)](https://travis-ci.org/magiclen/random-pick)
[![Build status](https://ci.appveyor.com/api/projects/status/0eh1bp01swr52eef/branch/master?svg=true)](https://ci.appveyor.com/project/magiclen/random-pick/branch/master)

Pick an element from a slice randomly by given weights.

## Example

```rust
extern crate random_pick;

enum Prize {
    Legendary,
    Rare,
    Enchanted,
    Common,
}

let prize_list = [Prize::Legendary, Prize::Rare, Prize::Enchanted, Prize::Common]; // available prizes

let slice = &prize_list;
let weights = [1, 5, 15, 30]; // a scale of chance of picking each kind of prize

let n = 1000000;
let mut counter = [0usize; 4];

for _ in 0..n {
    let picked_item = random_pick::pick_from_slice(slice, &weights).unwrap();

    match picked_item {
        Prize::Legendary=>{
            counter[0] += 1;
           }
        Prize::Rare=>{
            counter[1] += 1;
        }
        Prize::Enchanted=>{
            counter[2] += 1;
        }
        Prize::Common=>{
            counter[3] += 1;
        }
    }
}

println!("{}", counter[0]); // Should be close to 20000
println!("{}", counter[1]); // Should be close to 100000
println!("{}", counter[2]); // Should be close to 300000
println!("{}", counter[3]); // Should be close to 600000
```

The length of the slice is usually an integral multiple (larger than zero) of that of weights.


## Crates.io

https://crates.io/crates/random-pick

## Documentation

https://docs.rs/random-pick

## License

[MIT](LICENSE)