gam 0.3.88

Generalized penalized likelihood engine
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

/// Linear-interpolation quantile matching numpy.quantile default (method='linear').
pub fn quantile_from_sorted(sorted: &[f64], q: f64) -> f64 {
    let n = sorted.len();
    if n == 0 {
        return f64::NAN;
    }
    if n == 1 {
        return sorted[0];
    }
    let pos = q.clamp(0.0, 1.0) * (n - 1) as f64;
    let lo = pos.floor() as usize;
    let hi = (lo + 1).min(n - 1);
    let frac = pos - lo as f64;
    sorted[lo] * (1.0 - frac) + sorted[hi] * frac
}

/// Exact 1-based order statistic from an already sorted slice.
///
/// Returns `NaN` when the slice is empty, `rank` is zero, or `rank` exceeds
/// the number of observations. This is intentionally not an interpolating
/// quantile: split-conformal calibration needs the observed `k`-th value to
/// preserve the finite-sample coverage proof.
pub fn order_statistic_from_sorted(sorted: &[f64], rank: usize) -> f64 {
    if sorted.is_empty() || rank == 0 || rank > sorted.len() {
        return f64::NAN;
    }
    sorted[rank - 1]
}

/// Exact 1-based order statistic from an unsorted slice.
///
/// This centralizes the sort+select path for code that needs an observed
/// sample value rather than `quantile_from_sorted`'s linear interpolation.
pub fn order_statistic(values: &[f64], rank: usize) -> f64 {
    let mut sorted = values.to_vec();
    sorted.sort_by(f64::total_cmp);
    order_statistic_from_sorted(&sorted, rank)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn order_statistic_returns_nan_on_empty() {
        assert!(order_statistic(&[], 1).is_nan());
        assert!(order_statistic_from_sorted(&[], 1).is_nan());
    }

    #[test]
    fn order_statistic_returns_nan_on_zero_rank() {
        let v = [3.0, 1.0, 2.0];
        assert!(order_statistic(&v, 0).is_nan());
        let sorted = [1.0, 2.0, 3.0];
        assert!(order_statistic_from_sorted(&sorted, 0).is_nan());
    }

    #[test]
    fn order_statistic_returns_nan_when_rank_exceeds_len() {
        let v = [3.0, 1.0, 2.0];
        assert!(order_statistic(&v, 4).is_nan());
        let sorted = [1.0, 2.0, 3.0];
        assert!(order_statistic_from_sorted(&sorted, 4).is_nan());
    }

    #[test]
    fn order_statistic_hits_mid_rank() {
        // Unsorted input; the 1-based 3rd-smallest of {1,2,3,4,5} is 3.
        let v = [5.0, 1.0, 4.0, 2.0, 3.0];
        assert_eq!(order_statistic(&v, 3), 3.0);
        let sorted = [1.0, 2.0, 3.0, 4.0, 5.0];
        assert_eq!(order_statistic_from_sorted(&sorted, 3), 3.0);
        // Boundary ranks: first and last.
        assert_eq!(order_statistic(&v, 1), 1.0);
        assert_eq!(order_statistic(&v, 5), 5.0);
    }
}