rustyaid 0.1.0

A small library providing random data for testing puposes
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
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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264

use num::{Bounded, FromPrimitive, Signed};
use rand::distributions::uniform::SampleUniform;
use rand::distributions::Standard;
use rand::prelude::Distribution;
use rand::Rng;
use std::ops::{Add, Sub};

/// Generates a new random number
///
/// Generates a new number between the min and max values for the numerical type.
/// Supports any primitive numeric type with finite bounds
///
/// # Examples
///
/// Basic usage:
/// ```
/// use rustyaid::number::*;
/// let n: i32 = some_number();
/// ```
pub fn some_number<TYPE>() -> TYPE
where
    TYPE: Bounded,
    Standard: Distribution<TYPE>,
{
    let mut rng = rand::thread_rng();
    rng.gen()
}

/// Generates a new random positive number
///
/// Generates a new number between the `0` and max values for the numerical type.
/// Supports any primitive numeric type with finite bounds
///
/// # Examples
///
/// Basic usage:
/// ```
/// use rustyaid::number::*;
/// let n: i32 = some_positive_number();
/// ```
pub fn some_positive_number<TYPE>() -> TYPE
where
    TYPE: Bounded + FromPrimitive + PartialOrd + Add<Output = TYPE>,
    Standard: Distribution<TYPE>,
{
    let number = some_number();
    if number <= TYPE::from_i8(0).unwrap() {
        number.add(TYPE::max_value())
    } else {
        number
    }
}

/// Generates a new random negative number
///
/// Generates a new number between the min and `0` for the numerical type.
/// Supports any primitive numeric signed type with finite bounds
///
/// # Examples
///
/// Basic usage:
/// ```
/// use rustyaid::number::*;
/// let n: i32 = some_negative_number();
/// ```
pub fn some_negative_number<TYPE>() -> TYPE
where
    TYPE: Bounded + FromPrimitive + PartialOrd + Sub<Output = TYPE> + Signed,
    Standard: Distribution<TYPE>,
{
    let number = some_number();
    if number >= TYPE::from_i8(0).unwrap() {
        number.neg()
    } else {
        number
    }
}

/// Generates a new random number between `from`, inclusive, and `to`, exclusive
///
/// Generates a new number between the min and max values provided for the numerical type.
/// Supports any primitive numeric type with finite bounds
///
/// # Examples
///
/// Basic usage:
/// ```
/// use rustyaid::number::*;
/// let n: i32 = some_number_between(10, 20);
/// ```
pub fn some_number_between<TYPE>(from: TYPE, to: TYPE) -> TYPE
where
    TYPE: FromPrimitive + PartialOrd + Sub<Output = TYPE> + SampleUniform,
    Standard: Distribution<TYPE>,
{
    if from == to {
        from
    } else {
        let mut rand_generator = rand::thread_rng();
        rand_generator.gen_range(from..to)
    }
}

/// Generates a new random number between `from`, inclusive, and `to`, inclusive
///
/// Generates a new number between the min and max values provided for the numerical type.
/// Supports any primitive numeric type with finite bounds
///
/// # Examples
///
/// Basic usage:
/// ```
/// use rustyaid::number::*;
/// let n: i32 = some_number_between_inclusive(10, 20);
/// ```
pub fn some_number_between_inclusive<TYPE>(from: TYPE, to: TYPE) -> TYPE
where
    TYPE: FromPrimitive + PartialOrd + Sub<Output = TYPE> + SampleUniform,
    Standard: Distribution<TYPE>,
{
    if from == to {
        from
    } else {
        let mut rand_generator = rand::thread_rng();
        rand_generator.gen_range(from..=to)
    }
}

/// Generates a new random number greater than some value
///
/// Generates a new number between the provided minimum and the max value for the numerical type
/// Supports any primitive numeric type with finite bounds
/// Only supports generating positive numbers
///
/// # Examples
///
/// Basic usage:
/// ```
/// use rustyaid::number::*;
/// let n: i32 = some_number_greater_than(10);
/// ```
pub fn some_number_greater_than<TYPE>(bound: TYPE) -> TYPE
where
    TYPE: Bounded
        + FromPrimitive
        + PartialOrd
        + Add<Output = TYPE>
        + Sub<Output = TYPE>
        + SampleUniform,
    Standard: Distribution<TYPE>,
{
    let zero = TYPE::from_i8(0).unwrap();
    if bound < zero {
        panic!("Cannot handle negative value")
    }
    some_number_between(bound + TYPE::from_i8(1).unwrap(), TYPE::max_value())
}

/// Generates a new random number less than some value
///
/// Generates a new number between the the minimum value for the numerical type and the provided max value
/// Supports any primitive numeric type with finite bounds
/// Supports signed and unsigned types
/// Can generate negative values
///
/// # Examples
///
/// Basic usage:
/// ```
/// use rustyaid::number::*;
/// let n: i32 = some_number_less_than(10);
/// ```
pub fn some_number_less_than<TYPE>(bound: TYPE) -> TYPE
where
    TYPE: Bounded
        + FromPrimitive
        + PartialOrd
        + Add<Output = TYPE>
        + Sub<Output = TYPE>
        + SampleUniform,
    Standard: Distribution<TYPE>,
{
    some_number_between(TYPE::min_value(), bound)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn can_generate_random_signed_integers() {
        let _ = some_number::<i8>();
        let _ = some_number::<i16>();
        let _ = some_number::<i32>();
        let _ = some_number::<i64>();
        let _ = some_number::<i128>();
        let _ = some_number::<isize>();
    }

    #[test]
    fn can_generate_random_unsigned_integers() {
        let _ = some_number::<u8>();
        let _ = some_number::<u16>();
        let _ = some_number::<u32>();
        let _ = some_number::<u64>();
        let _ = some_number::<u128>();
        let _ = some_number::<usize>();
    }

    #[test]
    fn can_generate_random_signed_floats() {
        let _ = some_number::<f32>();
        let _ = some_number::<f64>();
    }

    #[test]
    fn can_generate_1000_positive_usize() {
        for _ in 0..1000 {
            let actual = some_positive_number::<usize>();
            assert!(actual > 0);
        }
    }

    #[test]
    fn can_generate_signed_integer_between() {
        let from = -1000;
        let to = 1000;
        let actual = some_number_between(from, to);
        assert!(actual >= from);
        assert!(actual < to);
    }

    #[test]
    fn can_generate_signed_integer_between_inclusive() {
        let from = -1000;
        let to = 1000;
        let actual = some_number_between_inclusive(from, to);
        assert!(actual >= from);
        assert!(actual <= to);
    }

    #[test]
    fn can_generate_unsigned_integer_between() {
        let from: u32 = 0;
        let to: u32 = 1000;
        let actual = some_number_between(from, to);
        assert!(actual >= from);
        assert!(actual < to);
    }

    #[test]
    fn can_generate_signed_number_less_than() {
        let to: u32 = 1000;
        let actual = some_number_less_than(to);
        assert!(actual < to);
    }

    #[test]
    fn can_generate_signed_number_greater_than() {
        let from: u32 = 1000;
        let actual = some_number_greater_than(from);
        assert!(actual > from);
    }
}