random_choice 0.3.2

Chooses samples randomly by their weights/probabilities.
Documentation
extern crate random_choice;
extern crate rand;

#[cfg(test)]
mod tests {
    use std::collections::BTreeMap;
    use random_choice::random_choice;
    use random_choice::RandomChoice;
    use rand::SeedableRng;

    #[test]
    fn test_random_choice_f64() {
        let capacity: usize = 500;
        let mut samples: Vec<usize> = Vec::with_capacity(capacity);
        let mut weights: Vec<f64> = Vec::with_capacity(capacity);

        for i in 0..capacity {
            samples.push(i);
            weights.push(i as f64);
        }

        let number_choices = 10000;
        let choices = random_choice().random_choice_f64(&samples, &weights, number_choices);

        assert!(choices.len() == number_choices);

        let mut weight_counter = BTreeMap::new();

        for choice in choices {
            let counter = weight_counter.entry(choice).or_insert(0);
            *counter += 1;
        }

        let mut last_value: usize = 0;

        for (_, value) in &weight_counter {
            assert!((last_value as i32 - (*value) as i32).abs() <= 2);
            last_value = *value;
            // println!("({}, {})", key, value);
        }
    }

    #[test]
    fn test_random_choice_f32() {
        let capacity: usize = 500;
        let mut samples: Vec<usize> = Vec::with_capacity(capacity);
        let mut weights: Vec<f32> = Vec::with_capacity(capacity);

        for i in 0..capacity {
            samples.push(i);
            weights.push(i as f32);
        }

        let number_choices = 10000;
        let choices = random_choice().random_choice_f32(&samples, &weights, number_choices);

        assert!(choices.len() == number_choices);

        let mut weight_counter = BTreeMap::new();

        for choice in choices {
            let counter = weight_counter.entry(choice).or_insert(0);
            *counter += 1;
        }

        let mut last_value: usize = 0;

        for (_, value) in &weight_counter {
            assert!((last_value as i32 - (*value) as i32).abs() <= 2);
            last_value = *value;
            // println!("({}, {})", key, value);
        }
    }

    #[test]
    fn test_random_choice_small_n_f32() {
        let capacity: usize = 500;
        let mut samples: Vec<usize> = Vec::with_capacity(capacity);
        let mut weights: Vec<f32> = Vec::with_capacity(capacity);

        for i in 0..capacity {
            samples.push(i);
            weights.push(i as f32);
        }

        // number_choices is smaller than the capacity
        let number_choices = 10;
        let choices = random_choice().random_choice_f32(&samples, &weights, number_choices);

        assert_eq!(choices.len(), number_choices);

        let mut weight_counter = BTreeMap::new();

        for choice in choices {
            let counter = weight_counter.entry(choice).or_insert(0);
            *counter += 1;
        }

        let mut last_value: usize = 0;

        for (_, value) in &weight_counter {
            assert!((last_value as i32 - (*value) as i32).abs() <= 2);
            last_value = *value;
            // println!("({}, {})", key, value);
        }
    }

    #[test]
    fn test_random_choice_small_n_f64() {
        let capacity: usize = 500;
        let mut samples: Vec<usize> = Vec::with_capacity(capacity);
        let mut weights: Vec<f64> = Vec::with_capacity(capacity);

        for i in 0..capacity {
            samples.push(i);
            weights.push(i as f64);
        }

        // number_choices is smaller than the capacity
        let number_choices = 100;
        let choices = random_choice().random_choice_f64(&samples, &weights, number_choices);

        assert_eq!(choices.len(), number_choices);

        let mut weight_counter = BTreeMap::new();

        for choice in choices {
            let counter = weight_counter.entry(choice).or_insert(0);
            *counter += 1;
        }

        let mut last_value: usize = 0;

        for (_, value) in &weight_counter {
            assert!((last_value as i32 - (*value) as i32).abs() <= 2);
            last_value = *value;
            // println!("({}, {})", key, value);
        }
    }

    #[test]
    fn test_random_choice_zero_elements_f64() {
        let capacity: usize = 1000;
        let mut samples: Vec<usize> = Vec::with_capacity(capacity);
        let mut weights: Vec<f64> = Vec::with_capacity(capacity);

        for i in 0..capacity {
            samples.push(i + 1);
            weights.push((i + 1usize) as f64);
        }

        let choices = random_choice().random_choice_f64(&samples, &weights, 0 as usize);

        assert!(choices.len() == 0);
    }

    #[test]
    fn test_random_choice_zero_elements_f32() {
        let capacity: usize = 1000;
        let mut samples: Vec<usize> = Vec::with_capacity(capacity);
        let mut weights: Vec<f32> = Vec::with_capacity(capacity);

        for i in 0..capacity {
            samples.push(i + 1);
            weights.push((i + 1usize) as f32);
        }

        let choices = random_choice().random_choice_f32(&samples, &weights, 0 as usize);

        assert!(choices.len() == 0);
    }

    #[test]
    fn test_random_choice_samples_zero_f64() {
        let capacity: usize = 1000;
        let samples: Vec<usize> = Vec::new();
        let mut weights: Vec<f64> = Vec::with_capacity(capacity);

        for i in 0..capacity {
            weights.push((i + 1usize) as f64);
        }

        let choices = random_choice().random_choice_f64(&samples, &weights, capacity);

        assert!(choices.len() == 0);
    }

    #[test]
    fn test_random_choice_samples_zero_f32() {
        let capacity: usize = 1000;
        let samples: Vec<usize> = Vec::new();
        let mut weights: Vec<f32> = Vec::with_capacity(capacity);

        for i in 0..capacity {
            weights.push((i + 1usize) as f32);
        }

        let choices = random_choice().random_choice_f32(&samples, &weights, capacity);

        assert!(choices.len() == 0);
    }

    #[test]
    fn test_random_choice_weights_zero_f64() {
        let capacity: usize = 1000;
        let mut samples: Vec<usize> = Vec::with_capacity(capacity);
        let weights: Vec<f64> = Vec::new();

        for i in 0..capacity {
            samples.push(i + 1);
        }

        let choices = random_choice().random_choice_f64(&samples, &weights, capacity);

        assert!(choices.len() == 0);
    }

    #[test]
    fn test_random_choice_weights_zero_f32() {
        let capacity: usize = 1000;
        let mut samples: Vec<usize> = Vec::with_capacity(capacity);
        let weights: Vec<f32> = Vec::new();

        for i in 0..capacity {
            samples.push(i + 1);
        }

        let choices = random_choice().random_choice_f32(&samples, &weights, capacity);

        assert!(choices.len() == 0);
    }

    #[test]
    fn test_random_choice_with_seed_f64() {
        let capacity: usize = 500;
        let mut samples: Vec<usize> = Vec::with_capacity(capacity);
        let mut weights: Vec<f64> = Vec::with_capacity(capacity);

        for i in 0..capacity {
            samples.push(i);
            weights.push(i as f64);
        }

        let rng = super::rand::StdRng::from_seed(&[5000, 44, 55, 199]);
        let mut random_choice = RandomChoice::new(rng);

        let number_choices = 10000;
        let choices = random_choice.random_choice_f64(&samples, &weights, number_choices);

        assert!(choices.len() == number_choices);

        let mut weight_counter = BTreeMap::new();

        for choice in choices {
            let counter = weight_counter.entry(choice).or_insert(0);
            *counter += 1;
        }

        let mut last_value: usize = 0;

        for (_, value) in &weight_counter {
            assert!((last_value as i32 - (*value) as i32).abs() <= 2);
            last_value = *value;
        }
    }
}