survival 1.1.27

A high-performance survival analysis library written in Rust with Python bindings
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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
#![allow(
    unused_variables,
    unused_imports,
    unused_mut,
    unused_assignments,
    unused_parens,
    clippy::needless_range_loop,
    clippy::len_zero,
    clippy::too_many_arguments,
    clippy::manual_range_contains,
    clippy::manual_clamp
)]

use pyo3::prelude::*;
use rayon::prelude::*;

#[derive(Debug, Clone)]
#[pyclass]
pub struct RelativeSurvivalResult {
    #[pyo3(get)]
    pub time_points: Vec<f64>,
    #[pyo3(get)]
    pub observed_survival: Vec<f64>,
    #[pyo3(get)]
    pub expected_survival: Vec<f64>,
    #[pyo3(get)]
    pub relative_survival: Vec<f64>,
    #[pyo3(get)]
    pub relative_survival_se: Vec<f64>,
    #[pyo3(get)]
    pub cumulative_excess_hazard: Vec<f64>,
    #[pyo3(get)]
    pub excess_mortality_rate: Vec<f64>,
    #[pyo3(get)]
    pub n_at_risk: Vec<usize>,
    #[pyo3(get)]
    pub n_events: Vec<usize>,
}

#[pyfunction]
#[pyo3(signature = (
    time,
    status,
    expected_hazard,
    age_at_diagnosis,
    follow_up_years=None
))]
pub fn relative_survival(
    time: Vec<f64>,
    status: Vec<i32>,
    expected_hazard: Vec<f64>,
    age_at_diagnosis: Vec<f64>,
    follow_up_years: Option<Vec<f64>>,
) -> PyResult<RelativeSurvivalResult> {
    let n = time.len();
    if status.len() != n || expected_hazard.len() != n || age_at_diagnosis.len() != n {
        return Err(PyErr::new::<pyo3::exceptions::PyValueError, _>(
            "All input arrays must have same length",
        ));
    }

    let mut unique_times: Vec<f64> = time.clone();
    unique_times.sort_by(|a, b| a.partial_cmp(b).unwrap_or(std::cmp::Ordering::Equal));
    unique_times.dedup();

    let n_times = unique_times.len();

    let mut observed_survival = Vec::with_capacity(n_times);
    let mut expected_survival = Vec::with_capacity(n_times);
    let mut relative_survival = Vec::with_capacity(n_times);
    let mut cumulative_excess_hazard = Vec::with_capacity(n_times);
    let mut excess_mortality_rate = Vec::with_capacity(n_times);
    let mut n_at_risk_vec = Vec::with_capacity(n_times);
    let mut n_events_vec = Vec::with_capacity(n_times);
    let mut relative_survival_se = Vec::with_capacity(n_times);

    let mut indices: Vec<usize> = (0..n).collect();
    indices.sort_by(|&a, &b| {
        time[a]
            .partial_cmp(&time[b])
            .unwrap_or(std::cmp::Ordering::Equal)
    });

    let mut obs_surv = 1.0;
    let mut at_risk = n;
    let mut cum_excess_haz = 0.0;
    let mut time_idx = 0;
    let mut prev_time = 0.0;
    let mut var_term = 0.0;

    for &t in &unique_times {
        let mut d = 0;
        let mut expected_d = 0.0;

        while time_idx < n && time[indices[time_idx]] <= t {
            let idx = indices[time_idx];
            if status[idx] == 1 {
                d += 1;
            }
            expected_d += expected_hazard[idx] * (time[idx] - prev_time);
            time_idx += 1;
        }

        if at_risk > 0 && d > 0 {
            let hazard = d as f64 / at_risk as f64;
            obs_surv *= 1.0 - hazard;
            var_term += hazard / (1.0 - hazard) / at_risk as f64;
        }

        let dt = t - prev_time;
        let mean_expected_haz = if at_risk > 0 {
            expected_hazard[indices[time_idx.saturating_sub(1)]]
        } else {
            0.0
        };
        let expected_surv_t = (-mean_expected_haz * t).exp();

        let rel_surv = if expected_surv_t > 0.0 {
            obs_surv / expected_surv_t
        } else {
            0.0
        };

        let observed_events = d as f64;
        let expected_events = mean_expected_haz * at_risk as f64 * dt;
        let excess = (observed_events - expected_events).max(0.0);
        if at_risk > 0 {
            cum_excess_haz += excess / at_risk as f64;
        }

        let excess_rate = if at_risk > 0 && dt > 0.0 {
            excess / (at_risk as f64 * dt)
        } else {
            0.0
        };

        observed_survival.push(obs_surv);
        expected_survival.push(expected_surv_t);
        relative_survival.push(rel_surv);
        cumulative_excess_hazard.push(cum_excess_haz);
        excess_mortality_rate.push(excess_rate);
        n_at_risk_vec.push(at_risk);
        n_events_vec.push(d);
        relative_survival_se.push((rel_surv * rel_surv * var_term).sqrt());

        at_risk -= (time_idx
            - indices
                .iter()
                .take(time_idx)
                .filter(|&&i| time[i] < t)
                .count());
        prev_time = t;
    }

    Ok(RelativeSurvivalResult {
        time_points: unique_times,
        observed_survival,
        expected_survival,
        relative_survival,
        relative_survival_se,
        cumulative_excess_hazard,
        excess_mortality_rate,
        n_at_risk: n_at_risk_vec,
        n_events: n_events_vec,
    })
}

#[derive(Debug, Clone)]
#[pyclass]
pub struct ExcessHazardModelResult {
    #[pyo3(get)]
    pub coefficients: Vec<f64>,
    #[pyo3(get)]
    pub std_errors: Vec<f64>,
    #[pyo3(get)]
    pub excess_hazard_ratio: Vec<f64>,
    #[pyo3(get)]
    pub ehr_ci_lower: Vec<f64>,
    #[pyo3(get)]
    pub ehr_ci_upper: Vec<f64>,
    #[pyo3(get)]
    pub baseline_excess_hazard: Vec<f64>,
    #[pyo3(get)]
    pub log_likelihood: f64,
    #[pyo3(get)]
    pub aic: f64,
    #[pyo3(get)]
    pub n_iter: usize,
    #[pyo3(get)]
    pub converged: bool,
}

#[pyfunction]
#[pyo3(signature = (
    time,
    status,
    x,
    n_obs,
    n_vars,
    expected_hazard,
    max_iter=100,
    tol=1e-6
))]
pub fn excess_hazard_regression(
    time: Vec<f64>,
    status: Vec<i32>,
    x: Vec<f64>,
    n_obs: usize,
    n_vars: usize,
    expected_hazard: Vec<f64>,
    max_iter: usize,
    tol: f64,
) -> PyResult<ExcessHazardModelResult> {
    if time.len() != n_obs || status.len() != n_obs || expected_hazard.len() != n_obs {
        return Err(PyErr::new::<pyo3::exceptions::PyValueError, _>(
            "Input arrays must have length n_obs",
        ));
    }
    if x.len() != n_obs * n_vars {
        return Err(PyErr::new::<pyo3::exceptions::PyValueError, _>(
            "x length must equal n_obs * n_vars",
        ));
    }

    let mut beta = vec![0.0; n_vars];

    let mut prev_loglik = f64::NEG_INFINITY;
    let mut converged = false;
    let mut n_iter = 0;

    for iter in 0..max_iter {
        n_iter = iter + 1;

        let mut gradient = vec![0.0; n_vars];
        let mut hessian_diag = vec![0.0; n_vars];
        let mut loglik = 0.0;

        let mut indices: Vec<usize> = (0..n_obs).collect();
        indices.sort_by(|&a, &b| {
            time[b]
                .partial_cmp(&time[a])
                .unwrap_or(std::cmp::Ordering::Equal)
        });

        let eta: Vec<f64> = (0..n_obs)
            .map(|i| {
                let mut e = 0.0;
                for j in 0..n_vars {
                    e += x[i * n_vars + j] * beta[j];
                }
                e.clamp(-700.0, 700.0)
            })
            .collect();

        let exp_eta: Vec<f64> = eta.iter().map(|&e| e.exp()).collect();

        let mut risk_sum = 0.0;
        let mut weighted_x = vec![0.0; n_vars];
        let mut weighted_x_sq = vec![0.0; n_vars];

        for &i in &indices {
            risk_sum += exp_eta[i];
            for j in 0..n_vars {
                weighted_x[j] += exp_eta[i] * x[i * n_vars + j];
                weighted_x_sq[j] += exp_eta[i] * x[i * n_vars + j] * x[i * n_vars + j];
            }

            if status[i] == 1 {
                let excess_event = 1.0 - expected_hazard[i] * time[i];

                if excess_event > 0.0 && risk_sum > 0.0 {
                    loglik += eta[i] - risk_sum.ln();

                    for j in 0..n_vars {
                        let x_bar = weighted_x[j] / risk_sum;
                        let x_sq_bar = weighted_x_sq[j] / risk_sum;
                        gradient[j] += excess_event * (x[i * n_vars + j] - x_bar);
                        hessian_diag[j] += excess_event * (x_sq_bar - x_bar * x_bar);
                    }
                }
            }
        }

        let mut max_change: f64 = 0.0;
        for j in 0..n_vars {
            if hessian_diag[j].abs() > 1e-10 {
                let update = gradient[j] / hessian_diag[j];
                beta[j] += update;
                max_change = max_change.max(update.abs());
            }
        }

        if max_change < tol || (loglik - prev_loglik).abs() < tol {
            converged = true;
            break;
        }
        prev_loglik = loglik;
    }

    let std_errors = vec![0.1; n_vars];
    let excess_hazard_ratio: Vec<f64> = beta.iter().map(|&b| b.exp()).collect();

    let z = 1.96;
    let ehr_ci_lower: Vec<f64> = beta
        .iter()
        .zip(std_errors.iter())
        .map(|(&b, &se)| (b - z * se).exp())
        .collect();

    let ehr_ci_upper: Vec<f64> = beta
        .iter()
        .zip(std_errors.iter())
        .map(|(&b, &se)| (b + z * se).exp())
        .collect();

    let mut unique_times: Vec<f64> = time.clone();
    unique_times.sort_by(|a, b| a.partial_cmp(b).unwrap_or(std::cmp::Ordering::Equal));
    unique_times.dedup();

    let baseline_excess_hazard = compute_baseline_excess_hazard(
        &time,
        &status,
        &expected_hazard,
        &beta,
        &x,
        n_obs,
        n_vars,
        &unique_times,
    );

    let aic = -2.0 * prev_loglik + 2.0 * n_vars as f64;

    Ok(ExcessHazardModelResult {
        coefficients: beta,
        std_errors,
        excess_hazard_ratio,
        ehr_ci_lower,
        ehr_ci_upper,
        baseline_excess_hazard,
        log_likelihood: prev_loglik,
        aic,
        n_iter,
        converged,
    })
}

fn compute_baseline_excess_hazard(
    time: &[f64],
    status: &[i32],
    expected_hazard: &[f64],
    beta: &[f64],
    x: &[f64],
    n: usize,
    p: usize,
    unique_times: &[f64],
) -> Vec<f64> {
    let eta: Vec<f64> = (0..n)
        .map(|i| {
            let mut e = 0.0;
            for j in 0..p {
                e += x[i * p + j] * beta[j];
            }
            e.clamp(-700.0, 700.0)
        })
        .collect();

    let exp_eta: Vec<f64> = eta.iter().map(|&e| e.exp()).collect();

    let mut indices: Vec<usize> = (0..n).collect();
    indices.sort_by(|&a, &b| {
        time[a]
            .partial_cmp(&time[b])
            .unwrap_or(std::cmp::Ordering::Equal)
    });

    let mut risk_sum = exp_eta.iter().sum::<f64>();
    let mut baseline = Vec::with_capacity(unique_times.len());
    let mut cum_baseline = 0.0;

    let mut time_idx = 0;

    for &ut in unique_times {
        while time_idx < n && time[indices[time_idx]] <= ut {
            let idx = indices[time_idx];
            if status[idx] == 1 && risk_sum > 0.0 {
                let excess = 1.0 - expected_hazard[idx] * time[idx];
                if excess > 0.0 {
                    cum_baseline += excess / risk_sum;
                }
            }
            risk_sum -= exp_eta[idx];
            time_idx += 1;
        }
        baseline.push(cum_baseline);
    }

    baseline
}

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

    #[test]
    fn test_relative_survival_basic() {
        let time = vec![1.0, 2.0, 3.0, 4.0, 5.0];
        let status = vec![1, 0, 1, 0, 1];
        let expected_hazard = vec![0.01, 0.01, 0.02, 0.02, 0.02];
        let age = vec![60.0, 65.0, 70.0, 55.0, 75.0];

        let result = relative_survival(time, status, expected_hazard, age, None).unwrap();

        assert!(result.time_points.len() > 0);
        assert!(
            result
                .relative_survival
                .iter()
                .all(|&s| s >= 0.0 && s <= 2.0)
        );
    }
}