ya-rand 0.3.1

A crate for simple and fast random number generation
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

# YA-Rand: Yet Another Rand

Provides simple and fast pseudo/crypto random number generation.

## Windows 10 users on Rust 1.71 or newer

It is ***highly*** recommend that you add `RUSTFLAGS=--cfg windows_raw_dylib` to your path. Currently, the
[`getrandom`] crate that's used to seed RNGs behind the scenes defers it's operation to `windows-targets`,
which by default links to a 5-12MB static lib. Adding the above cfg flag tells it to instead use the
`raw-dylib` feature, which was stabilized in Rust 1.71. This turns `windows-targets` into a small macro-only
library, which improves compile times and decreases binary size for both debug and release builds.

[`getrandom`]: https://github.com/rust-random/getrandom

## Usage

These are just a few simple examples to get you started.

```rust
use ya_rand::*;

// **Correct** instantiation is very easy.
// This seeds the RNG using operating system entropy,
// so you never have to worry about the quality of the
// initial state of RNG instances.
let mut rng = new_rng();

// Generate a random number with a given upper bound.
let max: u64 = 420;
let val = rng.bound(max);
assert!(val < max);

// Generate a random number in a given range.
let min: i64 = -69;
let max: i64 = 69;
let val = rng.range(min, max);
assert!(min <= val && val < max);

// Generate a random floating point value.
let val = rng.f64();
assert!(0.0 <= val && val < 1.0);

// Generate a random ascii digit: '0'..='9' as a char.
let digit = rng.ascii_digit();
assert!(digit.is_ascii_digit());
```

See https://docs.rs/ya-rand/latest/ya_rand/ for full documentation and more examples.