greeners 1.5.0

High-performance econometrics with R/Python formulas. Two-Way Clustering, Marginal Effects (AME/MEM), HC1-4, IV Predictions, Categorical C(var), Polynomial I(x^2), Interactions, Diagnostics. OLS, IV/2SLS, DiD, Logit/Probit, Panel (FE/RE), Time Series (VAR/VECM), Quantile!
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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
use crate::error::GreenersError;
use crate::linalg::LinalgInverse as _;
use crate::OLS;
use ndarray::{Array1, Array2};
use statrs::distribution::{ContinuousCDF, Normal};
use std::fmt;

// ── Helpers numéricos ────────────────────────────────────────────────────────

fn phi(x: f64) -> f64 {
    const INV_SQRT_2PI: f64 = 0.398_942_280_401_432_7;
    INV_SQRT_2PI * (-0.5 * x * x).exp()
}

fn norm_cdf(x: f64) -> f64 {
    Normal::new(0.0, 1.0).unwrap().cdf(x)
}

// ===========================================================================
// TobitResult
// ===========================================================================

#[derive(Debug)]
pub struct TobitResult {
    pub params: Array1<f64>,
    pub std_errors: Array1<f64>,
    pub t_values: Array1<f64>,
    pub p_values: Array1<f64>,
    pub sigma: f64,
    pub log_likelihood: f64,
    pub n_obs: usize,
    pub n_censored: usize,
    pub df_resid: usize,
    pub ll: f64,
    pub iterations: usize,
    pub variable_names: Option<Vec<String>>,
}

impl fmt::Display for TobitResult {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let thick = "".repeat(70);
        let thin = "".repeat(70);
        let n_unc = self.n_obs - self.n_censored;
        writeln!(f, "\n{thick}")?;
        writeln!(f, " Tobit  —  MLE  (censura inferior em {})", self.ll)?;
        writeln!(f, "{thick}")?;
        writeln!(
            f,
            " Obs: {:<8}  Censuradas: {:<6}  Não-cens.: {:<6}  Iter.: {}",
            self.n_obs, self.n_censored, n_unc, self.iterations
        )?;
        writeln!(
            f,
            " Log-L: {:.4}   σ: {:.4}   df_resid: {}",
            self.log_likelihood, self.sigma, self.df_resid
        )?;
        writeln!(f, "{thin}")?;
        writeln!(
            f,
            " {:<18} {:>12}  {:>12}  {:>8}  {:>8}",
            "Variável", "coef", "SE", "z", "P>|z|"
        )?;
        writeln!(f, " {}", "".repeat(64))?;
        let sig = |p: f64| {
            if p < 0.01 {
                "***"
            } else if p < 0.05 {
                "**"
            } else if p < 0.10 {
                "*"
            } else {
                ""
            }
        };
        for i in 0..self.params.len() {
            let name = self
                .variable_names
                .as_ref()
                .and_then(|v| v.get(i).cloned())
                .unwrap_or_else(|| format!("x{}", i + 1));
            writeln!(
                f,
                " {:<18} {:>12.4}  {:>12.4}  {:>8.3}  {:>8.4}  {}",
                name,
                self.params[i],
                self.std_errors[i],
                self.t_values[i],
                self.p_values[i],
                sig(self.p_values[i])
            )?;
        }
        writeln!(f, " {}", "".repeat(64))?;
        writeln!(f, " sigma            {:>12.4}", self.sigma)?;
        writeln!(f, "{thick}")?;
        writeln!(f, " *** p<0.01  ** p<0.05  * p<0.10")
    }
}

// ===========================================================================
// Tobit MLE — censura esquerda em `ll` (default 0)
// ===========================================================================

pub struct Tobit;

impl Tobit {
    /// Estima modelo Tobit por MLE via Newton-Raphson.
    ///
    /// * `y`  — variável dependente (permite y_i = ll para censuradas)
    /// * `x`  — regressores COM intercepto (n × k)
    /// * `ll` — limite inferior de censura (default 0.0)
    pub fn fit(
        y: &Array1<f64>,
        x: &Array2<f64>,
        ll: f64,
        variable_names: Option<Vec<String>>,
    ) -> Result<TobitResult, GreenersError> {
        let n = y.len();
        let k = x.ncols();

        if x.nrows() != n {
            return Err(GreenersError::ShapeMismatch(
                "Tobit: y e x têm dimensões incompatíveis".into(),
            ));
        }
        if y.iter().any(|v| !v.is_finite()) || x.iter().any(|v| !v.is_finite()) {
            return Err(GreenersError::InvalidOperation(
                "Tobit: dados contêm NaN ou Inf".into(),
            ));
        }
        if n <= k {
            return Err(GreenersError::ShapeMismatch(
                "Tobit: graus de liberdade insuficientes".into(),
            ));
        }

        // ── Indicador de censura ──
        let d: Vec<bool> = y.iter().map(|&yi| yi > ll).collect();
        let n_censored = d.iter().filter(|&&b| !b).count();

        // ── Inicialização: OLS nos não-censurados ──
        let unc_idx: Vec<usize> = (0..n).filter(|&i| d[i]).collect();
        let y_unc: Array1<f64> = unc_idx.iter().map(|&i| y[i]).collect::<Vec<_>>().into();
        let x_unc: Array2<f64> = {
            let rows: Vec<ndarray::ArrayView1<f64>> = unc_idx.iter().map(|&i| x.row(i)).collect();
            ndarray::stack(ndarray::Axis(0), &rows).unwrap()
        };

        let ols_init =
            OLS::fit(&y_unc, &x_unc, crate::CovarianceType::NonRobust).unwrap_or_else(|_| {
                OLS::fit(y, x, crate::CovarianceType::NonRobust)
                    .expect("Tobit: falha na inicialização OLS")
            });

        let mut beta = ols_init.params.clone();
        let init_sigma = {
            let resid = &y_unc - &x_unc.dot(&beta);
            let ssr = resid.dot(&resid);
            (ssr / (y_unc.len().saturating_sub(k)) as f64)
                .sqrt()
                .max(1e-6)
        };
        let mut gamma = init_sigma.ln(); // γ = ln σ

        let norm =
            Normal::new(0.0, 1.0).map_err(|e| GreenersError::InvalidOperation(e.to_string()))?;

        let tol = 1e-7;
        let max_iter = 200;
        let mut iter = 0;
        let mut log_lik = f64::NEG_INFINITY;

        loop {
            let sigma = gamma.exp();
            let s2 = sigma * sigma;

            // ── Gradient e Hessian ──
            let mut g_beta = Array1::<f64>::zeros(k);
            let mut g_gamma = 0.0_f64;

            // Hessian k+1 × k+1 organizado como bloco [[H_bb, H_bg], [H_bg', H_gg]]
            let mut h_bb = Array2::<f64>::zeros((k, k));
            let mut h_bg = Array1::<f64>::zeros(k);
            let mut h_gg = 0.0_f64;

            let mut ll_val = 0.0_f64;
            const LOG_SQRT_2PI: f64 = 0.918_938_533_204_672_7;

            for i in 0..n {
                let xb = x.row(i).dot(&beta);
                if d[i] {
                    // Não censurada
                    let e = (y[i] - xb) / sigma;
                    ll_val += -gamma - LOG_SQRT_2PI - 0.5 * e * e;

                    let e_s = e / sigma; // e/σ
                    g_beta.scaled_add(e_s, &x.row(i));
                    g_gamma += e * e - 1.0;

                    // H_bb[j,k] -= x_ij * x_ik / σ²
                    let xi = x.row(i);
                    for j in 0..k {
                        for kk in 0..k {
                            h_bb[[j, kk]] -= xi[j] * xi[kk] / s2;
                        }
                    }
                    // H_bg[j] -= 2*e/σ * x_ij
                    h_bg.scaled_add(-2.0 * e / sigma, &xi);
                    // H_gg -= 2*e²
                    h_gg -= 2.0 * e * e;
                } else {
                    // Censurada
                    let a = (xb - ll) / sigma;
                    let (phi_neg_ln, lam, delta, c) = if a > 30.0 {
                        let l = a + 1.0 / a;
                        (
                            -0.5 * a * a - LOG_SQRT_2PI - l.ln(),
                            l,
                            1.0 + 1.0 / (a * a),
                            l * (a * (1.0 / a) + 1.0),
                        )
                    } else {
                        let phi_neg = norm_cdf(-a).max(1e-300);
                        let l = phi(a) / phi_neg;
                        (phi_neg.ln(), l, l * (l - a), l * (a * (l - a) + 1.0))
                    };

                    ll_val += phi_neg_ln;

                    // g_beta -= λ/σ * x_i
                    g_beta.scaled_add(-lam / sigma, &x.row(i));
                    // g_gamma += λ*a
                    g_gamma += lam * a;

                    let xi = x.row(i);
                    // H_bb -= δ/σ² * x_i x_i'
                    for j in 0..k {
                        for kk in 0..k {
                            h_bb[[j, kk]] -= delta * xi[j] * xi[kk] / s2;
                        }
                    }
                    // H_bg += c/σ * x_i
                    h_bg.scaled_add(c / sigma, &xi);
                    // H_gg -= a*c
                    h_gg -= a * c;
                }
            }

            // ── Monta Hessian k+1 × k+1 e gradiente k+1 ──
            let m = k + 1;
            let mut h_full = Array2::<f64>::zeros((m, m));
            let mut g_full = Array1::<f64>::zeros(m);

            for j in 0..k {
                for kk in 0..k {
                    h_full[[j, kk]] = h_bb[[j, kk]];
                }
                h_full[[j, k]] = h_bg[j];
                h_full[[k, j]] = h_bg[j];
                g_full[j] = g_beta[j];
            }
            h_full[[k, k]] = h_gg;
            g_full[k] = g_gamma;

            // Newton: θ += (-H)⁻¹ g  (sobe na log-verossimilhança)
            let neg_h = h_full.mapv(|v| -v);
            let neg_h_inv = match neg_h.inv() {
                Ok(m) => m,
                Err(_) => return Err(GreenersError::OptimizationFailed),
            };
            let step = neg_h_inv.dot(&g_full);

            // backtracking line search para garantir subida
            let mut alpha = 1.0_f64;
            for _ in 0..20 {
                let b_new = &beta + &step.slice(ndarray::s![..k]).to_owned() * alpha;
                let g_new = gamma + step[k] * alpha;
                let ll_new = Self::log_lik(y, x, &d, ll, &b_new, g_new, &norm);
                if ll_new > ll_val - 1e-10 {
                    beta = b_new;
                    gamma = g_new;
                    break;
                }
                alpha *= 0.5;
            }

            let diff = (log_lik - ll_val).abs();
            log_lik = ll_val;
            iter += 1;

            if diff < tol || iter >= max_iter {
                break;
            }
        }

        if iter >= max_iter {
            return Err(GreenersError::OptimizationFailed);
        }

        // ── SE: diagonal de (-H)⁻¹ na convergência ──
        let sigma = gamma.exp();
        let s2 = sigma * sigma;

        let mut h_bb = Array2::<f64>::zeros((k, k));
        let mut h_bg = Array1::<f64>::zeros(k);
        let mut h_gg = 0.0_f64;

        for i in 0..n {
            let xb = x.row(i).dot(&beta);
            let xi = x.row(i);
            if d[i] {
                let e = (y[i] - xb) / sigma;
                for j in 0..k {
                    for kk in 0..k {
                        h_bb[[j, kk]] -= xi[j] * xi[kk] / s2;
                    }
                }
                h_bg.scaled_add(-2.0 * e / sigma, &xi);
                h_gg -= 2.0 * e * e;
            } else {
                let a = (xb - ll) / sigma;
                let (_, delta, c) = if a > 30.0 {
                    let l = a + 1.0 / a;
                    (l, 1.0 + 1.0 / (a * a), l * (a * (1.0 / a) + 1.0))
                } else {
                    let phi_neg = norm_cdf(-a).max(1e-300);
                    let l = phi(a) / phi_neg;
                    (l, l * (l - a), l * (a * (l - a) + 1.0))
                };
                for j in 0..k {
                    for kk in 0..k {
                        h_bb[[j, kk]] -= delta * xi[j] * xi[kk] / s2;
                    }
                }
                h_bg.scaled_add(c / sigma, &xi);
                h_gg -= a * c;
            }
        }

        let m = k + 1;
        let mut h_full = Array2::<f64>::zeros((m, m));
        for j in 0..k {
            for kk in 0..k {
                h_full[[j, kk]] = h_bb[[j, kk]];
            }
            h_full[[j, k]] = h_bg[j];
            h_full[[k, j]] = h_bg[j];
        }
        h_full[[k, k]] = h_gg;

        let neg_h = h_full.mapv(|v| -v);
        let vcov = neg_h.inv()?;

        let std_errors: Array1<f64> = (0..k)
            .map(|i| vcov[[i, i]].max(0.0).sqrt())
            .collect::<Vec<_>>()
            .into();
        let t_values = &beta / &std_errors;
        let p_values: Array1<f64> = t_values.mapv(|z| 2.0 * (1.0 - norm.cdf(z.abs())));

        Ok(TobitResult {
            params: beta,
            std_errors,
            t_values,
            p_values,
            sigma,
            log_likelihood: log_lik,
            n_obs: n,
            n_censored,
            df_resid: n - k,
            ll,
            iterations: iter,
            variable_names,
        })
    }

    fn log_lik(
        y: &Array1<f64>,
        x: &Array2<f64>,
        d: &[bool],
        ll: f64,
        beta: &Array1<f64>,
        gamma: f64,
        norm: &Normal,
    ) -> f64 {
        let sigma = gamma.exp();
        const LOG_SQRT_2PI: f64 = 0.918_938_533_204_672_7;
        let mut val = 0.0_f64;
        for i in 0..y.len() {
            let xb = x.row(i).dot(beta);
            if d[i] {
                let e = (y[i] - xb) / sigma;
                val += -gamma - LOG_SQRT_2PI - 0.5 * e * e;
            } else {
                let a = (xb - ll) / sigma;
                if a > 30.0 {
                    let lam = a + 1.0 / a;
                    val += -0.5 * a * a - LOG_SQRT_2PI - lam.ln();
                } else {
                    val += norm.cdf(-a).max(1e-300).ln();
                }
            }
        }
        val
    }
}