easyrand 0.4.0

Simpler to use random number library for the Rust language
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

extern crate rand;

use rand::seq::SliceRandom;
use rand::Rng;
use rand::SeedableRng;

/// Returns a random numnber between 0.0 and 1.0
pub fn random() -> f64 {
    rand::random::<f64>()
}

/// Returns a random number in the specified range
pub fn randrange(min: f64, max: f64) -> f64 {
    rand::thread_rng().gen_range(min..max)
}

/// Returns a random integer in the specified range
pub fn randint(min: i64, max: i64) -> i64 {
    rand::thread_rng().gen_range(min..max)
}

// True or false
pub fn randbool() -> bool {
    rand::thread_rng().gen()
}

/// In-place shuffle of the given object
pub fn shuffle<T>(obj: &mut Vec<T>) {
    let mut rng = rand::thread_rng();
    obj.shuffle(&mut rng);
}

/// Return a reference to a randomly selected item in the given object
pub fn choose<T>(obj: &Vec<T>) -> Option<&T> {
    let mut rng = rand::thread_rng();
    obj.choose(&mut rng)
}

/// Convinence method to get seedable
pub fn with_seed(seed: u64) -> SeededRand {
    SeededRand::new(seed)
}

pub struct SeededRand {
    rng: rand::rngs::StdRng,
}

/// Creates predictible random numbers using a given seed value
impl SeededRand {
    pub fn new(seed: u64) -> Self {
        SeededRand {
            rng: rand::rngs::StdRng::seed_from_u64(seed),
        }
    }

    /// Returns a random numnber between 0.0 and 1.0
    pub fn random(&mut self) -> f64 {
        self.rng.gen()
    }

    /// Returns a random number in the specified range
    pub fn randrange(&mut self, min: f64, max: f64) -> f64 {
        self.rng.gen_range(min..max)
    }

    // True or false
    pub fn randbool(&mut self) -> bool {
        self.rng.gen()
    }

    /// Returns a random integer in the specified range
    pub fn randint(&mut self, min: i64, max: i64) -> i64 {
        self.rng.gen_range(min..max)
    }

    /// In-place shuffle of the given object
    pub fn shuffle<T>(&mut self, obj: &mut Vec<T>) {
        obj.shuffle(&mut self.rng);
    }

    /// Return a reference to a randomly selected item in the given object
    pub fn choose<'a, T>(&mut self, obj: &'a Vec<T>) -> Option<&'a T> {
        obj.choose(&mut self.rng)
    }
}