rstmt-core 0.1.0

the core modules for the rstmt framework
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

/*
    appellation: impl_octave_rand <module>
    authors: @FL03
*/
use crate::octave::Octave;
use rand::{Rng, RngExt};
use rand_distr::uniform::{SampleRange, SampleUniform};
use rand_distr::{Distribution, StandardNormal, StandardUniform};

impl<T> Octave<T> {
    /// generate a random octave
    pub fn random() -> Self
    where
        StandardUniform: Distribution<T>,
    {
        Octave(rand::random())
    }
    /// generates a random octave using the provided random number generator.
    pub fn random_in<R>(rng: &mut R) -> Self
    where
        R: ?Sized + Rng,
        StandardUniform: Distribution<T>,
    {
        Octave(rng.random())
    }
    /// generates a random octave using the provided random number generator.
    pub fn random_with<R, Distr>(rng: &mut R, distr: Distr) -> Self
    where
        R: ?Sized + Rng,
        Distr: Distribution<T>,
    {
        Octave(rng.sample(distr))
    }
    /// generates a random octave within the specified range.
    pub fn random_range<R>(range: R) -> Self
    where
        R: SampleRange<T>,
        T: SampleUniform,
    {
        Self(rand::random_range(range))
    }
}

impl<T> Distribution<Octave<T>> for StandardUniform
where
    StandardUniform: Distribution<T>,
{
    fn sample<R: rand::Rng + ?Sized>(&self, rng: &mut R) -> Octave<T> {
        Octave::random_with(rng, StandardUniform)
    }
}

impl<T> Distribution<Octave<T>> for StandardNormal
where
    StandardNormal: Distribution<T>,
{
    fn sample<R: rand::Rng + ?Sized>(&self, rng: &mut R) -> Octave<T> {
        Octave::random_with(rng, StandardNormal)
    }
}