gevlib 0.1.4

A Rust library containing distributional quantities (CDF, PDF, Quantile, random generation) of the Extreme Value Distributions.
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

//! Functions used for the distributions.

// To verify that specific domains of parameters are respected.
// In fact this macro comes form: https://docs.rs/probability/latest/src/probability/lib.rs.html#1-35

/// macro used to ensure that the given domain is valid.
#[macro_use]
pub mod macros {
    macro_rules! domain( // should you consider an error enum instead? What is faster? More understandable? One variant for param and one for quantile domain
        ($requirement:expr) => (debug_assert!($requirement));
        ($requirement:expr, $code:expr) => (debug_assert!($code, stringify!($requirement)));
    );
}

/// Distributional Quantity trait (i.e. each distribution will provide each of the following
/// quantities: the CDF, PDF, Quantile and random generation)
pub trait DistQuant {
    /// Cumulative Distribution Function (CDF)
    fn cdf(&self, x: f64) -> f64;
    /// Probability Density Function (PDF)
    fn pdf(&self, x: f64) -> f64;
    /// Quantile Function
    fn quantile(&self, x: f64) -> f64;
    /// Generate a random value from the distribution
    fn random(&self, seed: RandomSeed) -> f64;
}

/// Seeding for the random generation of the distributions.
/// Can either be Empty (i.e. use random seed) or with a given u64 seed.
pub enum RandomSeed {
    Empty,
    Seed(u64),
}

/// Default Trait
impl Default for RandomSeed {
    /// Default seed is Empty (i.e. random seed)
    fn default() -> Self {
        RandomSeed::Empty
    }
}

impl RandomSeed {
    /// To be able to retrieve the given seed, if ever needed.
    pub fn get_seed(&self) -> Option<u64> {
        match self {
            RandomSeed::Empty => None,
            RandomSeed::Seed(val) => Some(*val),
        }
    }
}