gamlss-core 0.1.0

Core type-driven abstractions for GAMLSS modeling
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

/// Контракт распределения для скомпилированного GAMLSS-objective.
///
/// Пользовательские распределения реализуют этот trait. Арность параметров,
/// роли параметров и совместимость link-функций задаются через
/// [`ParameterizedFamily`], поэтому hot path остаётся типизированным без
/// dynamic lookup.
pub trait Family {
    /// Аддитивные предикторы на link-шкале.
    type Eta;
    /// Параметры распределения на естественной шкале.
    type Theta;
    /// Градиент negative log-likelihood по `Eta`.
    type ScoreEta;

    /// Преобразует предикторы с link-шкалы в параметры распределения.
    fn theta(&self, eta: Self::Eta) -> Self::Theta;
    /// Negative log-likelihood для одного наблюдения на естественной шкале.
    fn nll(&self, y: f64, theta: Self::Theta) -> f64;
    /// Negative log-likelihood для одного наблюдения на link-шкале.
    fn nll_eta(&self, y: f64, eta: Self::Eta) -> f64 {
        self.nll(y, self.theta(eta))
    }
    /// Negative log-likelihood и score по `Eta` для одного наблюдения.
    fn nll_and_score_eta(&self, y: f64, eta: Self::Eta) -> (f64, Self::ScoreEta);
}

/// Контейнер для eta или score у family с фиксированной арностью `K`.
pub trait ParameterParts<const K: usize>: Sized {
    /// Собирает контейнер из `K` scalar-частей.
    fn from_array(values: [f64; K]) -> Self;
    /// Возвращает scalar-часть по индексу.
    ///
    /// Реализации могут считать, что вызывающий код передаёт индекс меньше `K`.
    fn part(&self, index: usize) -> f64;
}

impl ParameterParts<1> for f64 {
    #[inline(always)]
    fn from_array(values: [f64; 1]) -> Self {
        values[0]
    }

    #[inline(always)]
    fn part(&self, index: usize) -> f64 {
        match index {
            0 => *self,
            _ => unreachable!("one-parameter parts only have index 0"),
        }
    }
}

impl ParameterParts<2> for (f64, f64) {
    #[inline(always)]
    fn from_array(values: [f64; 2]) -> Self {
        (values[0], values[1])
    }

    #[inline(always)]
    fn part(&self, index: usize) -> f64 {
        match index {
            0 => self.0,
            1 => self.1,
            _ => unreachable!("two-parameter parts only have indices 0 and 1"),
        }
    }
}

impl ParameterParts<3> for (f64, f64, f64) {
    #[inline(always)]
    fn from_array(values: [f64; 3]) -> Self {
        (values[0], values[1], values[2])
    }

    #[inline(always)]
    fn part(&self, index: usize) -> f64 {
        match index {
            0 => self.0,
            1 => self.1,
            2 => self.2,
            _ => unreachable!("three-parameter parts only have indices 0, 1 and 2"),
        }
    }
}

impl ParameterParts<4> for (f64, f64, f64, f64) {
    #[inline(always)]
    fn from_array(values: [f64; 4]) -> Self {
        (values[0], values[1], values[2], values[3])
    }

    #[inline(always)]
    fn part(&self, index: usize) -> f64 {
        match index {
            0 => self.0,
            1 => self.1,
            2 => self.2,
            3 => self.3,
            _ => unreachable!("four-parameter parts only have indices 0, 1, 2 and 3"),
        }
    }
}

/// Family с фиксированным числом параметров, ролями параметров и link-функциями.
///
/// `Params` и `Links` задаются tuple-ами той же длины, что и арность family.
pub trait ParameterizedFamily<const K: usize>: Family
where
    Self::Eta: ParameterParts<K>,
    Self::ScoreEta: ParameterParts<K>,
{
    /// Роли параметров family.
    type Params;
    /// Link-функции параметров family.
    type Links;
}

/// Distribution helper для CDF.
pub trait HasCdf: Family {
    /// CDF в точке `y` для параметров на естественной шкале.
    fn cdf(&self, y: f64, theta: Self::Theta) -> f64;
}

/// Distribution helper для quantile function.
pub trait HasQuantile: Family {
    /// Квантиль уровня `p` для параметров на естественной шкале.
    fn quantile(&self, p: f64, theta: Self::Theta) -> f64;
}

/// Distribution helper для simulation.
pub trait CanSimulate<Rng>: Family {
    /// Генерирует одно значение для параметров на естественной шкале.
    fn sample(&self, rng: &mut Rng, theta: Self::Theta) -> f64;
}