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
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
/*!
# Random Pick
Pick an element from a slice randomly by given weights.

## Examples

```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.

If you have multiple slices, you don't need to use extra space to concat them, just use the `pick_from_multiple_slices` function, instead of `pick_from_slice`.

Besides picking a single element from a slice or slices, you can also use `pick_multiple_from_slice` and `pick_multiple_from_multiple_slices` functions. Their overhead is lower than that of non-multiple-pick functions with extra loops.
*/

#[macro_use]
extern crate random_number;

use random_number::rand::thread_rng;

const MAX_NUMBER: usize = usize::max_value();

/// Pick an element from a slice randomly by given weights.
pub fn pick_from_slice<'a, T>(slice: &'a [T], weights: &'a [usize]) -> Option<&'a T> {
    let slice_len = slice.len();

    let index = gen_usize_with_weights(slice_len, weights)?;

    Some(&slice[index])
}

/// Pick an element from multiple slices randomly by given weights.
pub fn pick_from_multiple_slices<'a, T>(slices: &[&'a [T]], weights: &'a [usize]) -> Option<&'a T> {
    let len: usize = slices.iter().map(|slice| slice.len()).sum();

    let mut index = gen_usize_with_weights(len, weights)?;

    for slice in slices {
        let len = slice.len();

        if index < len {
            return Some(&slice[index]);
        } else {
            index -= len;
        }
    }

    None
}

/// Pick multiple elements from a slice randomly by given weights.
pub fn pick_multiple_from_slice<'a, T>(
    slice: &'a [T],
    weights: &'a [usize],
    count: usize,
) -> Vec<&'a T> {
    let slice_len = slice.len();

    gen_multiple_usize_with_weights(slice_len, weights, count)
        .iter()
        .map(|&index| &slice[index])
        .collect()
}

/// Pick multiple elements from multiple slices randomly by given weights.
pub fn pick_multiple_from_multiple_slices<'a, T>(
    slices: &[&'a [T]],
    weights: &'a [usize],
    count: usize,
) -> Vec<&'a T> {
    let len: usize = slices.iter().map(|slice| slice.len()).sum();

    gen_multiple_usize_with_weights(len, weights, count)
        .iter()
        .map(|index| {
            let mut index = *index;

            let mut s = slices[0];

            for slice in slices {
                let len = slice.len();

                if index < len {
                    s = slice;
                    break;
                } else {
                    index -= len;
                }
            }

            &s[index]
        })
        .collect()
}

/// Get a usize value by given weights.
pub fn gen_usize_with_weights(high: usize, weights: &[usize]) -> Option<usize> {
    let weights_len = weights.len();

    if weights_len == 0 || high == 0 {
        return None;
    } else if weights_len == 1 {
        if weights[0] == 0 {
            return None;
        }

        return Some(random!(0..high));
    } else {
        let mut weights_sum = 0f64;
        let mut max_weight = 0;

        for w in weights.iter().copied() {
            weights_sum += w as f64;
            if w > max_weight {
                max_weight = w;
            }
        }

        if max_weight == 0 {
            return None;
        }

        let mut rng = thread_rng();

        let index_scale = (high as f64) / (weights_len as f64);

        let weights_scale = (MAX_NUMBER as f64) / weights_sum;

        let rnd = random!(0..=MAX_NUMBER, rng) as f64;

        let mut temp = 0f64;

        for (i, w) in weights.iter().copied().enumerate() {
            temp += (w as f64) * weights_scale;
            if temp > rnd {
                let index = ((i as f64) * index_scale) as usize;

                return Some(random!(index..((((i + 1) as f64) * index_scale) as usize), rng));
            }
        }
    }

    None
}

/// Get multiple usize values by given weights.
pub fn gen_multiple_usize_with_weights(high: usize, weights: &[usize], count: usize) -> Vec<usize> {
    let mut result: Vec<usize> = Vec::with_capacity(count);

    let weights_len = weights.len();

    if weights_len > 0 && high > 0 {
        if weights_len == 1 {
            if weights[0] != 0 {
                let mut rng = thread_rng();

                for _ in 0..count {
                    result.push(random!(0..high, rng));
                }
            }
        } else {
            let mut weights_sum = 0f64;
            let mut max_weight = 0;

            for w in weights.iter().copied() {
                weights_sum += w as f64;
                if w > max_weight {
                    max_weight = w;
                }
            }

            if max_weight > 0 {
                let index_scale = (high as f64) / (weights_len as f64);

                let weights_scale = (MAX_NUMBER as f64) / weights_sum;

                let mut rng = thread_rng();

                for _ in 0..count {
                    let rnd = random!(0..=MAX_NUMBER, rng) as f64;

                    let mut temp = 0f64;

                    for (i, w) in weights.iter().copied().enumerate() {
                        temp += (w as f64) * weights_scale;
                        if temp > rnd {
                            let index = ((i as f64) * index_scale) as usize;

                            result.push(random!(
                                index..((((i + 1) as f64) * index_scale) as usize),
                                rng
                            ));
                            break;
                        }
                    }
                }
            }
        }
    }

    result
}