survival 1.0.10

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
#![allow(dead_code)]
use ndarray::{Array1, Array2};
use ndarray_linalg::cholesky::CholeskyInto;
use ndarray_linalg::{Inverse, Solve};
use rayon::prelude::*;
use thiserror::Error;
#[derive(Error, Debug)]
pub enum CoxError {
    #[error("Cholesky decomposition failed")]
    CholeskyDecomposition,
    #[error("Matrix inversion failed")]
    MatrixInversion,
    #[error("Non-finite values encountered during iteration")]
    NonFinite,
}
#[derive(Debug, Clone, Copy)]
pub enum Method {
    Breslow,
    Efron,
}
pub type CoxFitResults = (
    Vec<f64>,
    Vec<f64>,
    Vec<f64>,
    Array2<f64>,
    [f64; 2],
    f64,
    i32,
    usize,
);
pub struct CoxFit {
    time: Array1<f64>,
    status: Array1<i32>,
    covar: Array2<f64>,
    strata: Array1<i32>,
    offset: Array1<f64>,
    weights: Array1<f64>,
    method: Method,
    max_iter: usize,
    eps: f64,
    toler: f64,
    scale: Vec<f64>,
    means: Vec<f64>,
    beta: Vec<f64>,
    u: Vec<f64>,
    imat: Array2<f64>,
    loglik: [f64; 2],
    sctest: f64,
    flag: i32,
    iter: usize,
}
impl CoxFit {
    #[allow(clippy::too_many_arguments)]
    pub fn new(
        time: Array1<f64>,
        status: Array1<i32>,
        covar: Array2<f64>,
        strata: Array1<i32>,
        offset: Array1<f64>,
        weights: Array1<f64>,
        method: Method,
        max_iter: usize,
        eps: f64,
        toler: f64,
        doscale: Vec<bool>,
        initial_beta: Vec<f64>,
    ) -> Result<Self, CoxError> {
        let nvar = covar.ncols();
        let _nused = covar.nrows();
        let mut cox = Self {
            time,
            status,
            covar,
            strata,
            offset,
            weights,
            method,
            max_iter,
            eps,
            toler,
            scale: vec![1.0; nvar],
            means: vec![0.0; nvar],
            beta: initial_beta,
            u: vec![0.0; nvar],
            imat: Array2::zeros((nvar, nvar)),
            loglik: [0.0; 2],
            sctest: 0.0,
            flag: 0,
            iter: 0,
        };
        cox.scale_center(doscale)?;
        Ok(cox)
    }
    fn scale_center(&mut self, doscale: Vec<bool>) -> Result<(), CoxError> {
        let nvar = self.covar.ncols();
        let nused = self.covar.nrows();
        let total_weight: f64 = self.weights.sum();
        let means: Vec<f64> = (0..nvar)
            .into_par_iter()
            .map(|i| {
                if !doscale[i] {
                    0.0
                } else {
                    let mut mean = 0.0;
                    for (person, &w) in self.weights.iter().enumerate() {
                        mean += w * self.covar[(person, i)];
                    }
                    mean / total_weight
                }
            })
            .collect();
        let scales: Vec<f64> = (0..nvar)
            .into_par_iter()
            .map(|i| {
                if !doscale[i] {
                    1.0
                } else {
                    let mean = means[i];
                    let abs_sum: f64 = (0..nused)
                        .map(|person| self.weights[person] * (self.covar[(person, i)] - mean).abs())
                        .sum();
                    if abs_sum > 0.0 {
                        total_weight / abs_sum
                    } else {
                        1.0
                    }
                }
            })
            .collect();
        for i in 0..nvar {
            if doscale[i] {
                let mean = means[i];
                let scale_val = scales[i];
                for person in 0..nused {
                    self.covar[(person, i)] = (self.covar[(person, i)] - mean) * scale_val;
                }
            }
        }
        self.means = means;
        self.scale = scales;
        let new_beta: Vec<f64> = self
            .beta
            .par_iter()
            .zip(self.scale.par_iter())
            .map(|(&b, &s)| b / s)
            .collect();
        self.beta = new_beta;
        Ok(())
    }
    fn iterate(&mut self, beta: &[f64]) -> Result<f64, CoxError> {
        let nvar = self.covar.ncols();
        let nused = self.covar.nrows();
        let method = self.method;
        self.u.fill(0.0);
        self.imat.fill(0.0);
        let mut a = vec![0.0; nvar];
        let mut a2 = vec![0.0; nvar];
        let mut cmat = Array2::zeros((nvar, nvar));
        let mut cmat2 = Array2::zeros((nvar, nvar));
        let mut loglik = 0.0;
        let mut person = nused as isize - 1;
        while person >= 0 {
            let person_idx = person as usize;
            if self.strata[person_idx] == 1 {
                a.fill(0.0);
                cmat.fill(0.0);
            }
            let dtime = self.time[person_idx];
            let mut ndead = 0;
            let mut deadwt = 0.0;
            let mut denom2 = 0.0;
            let mut _nrisk = 0;
            let mut denom = 0.0;
            while person >= 0 && self.time[person as usize] == dtime {
                let person_i = person as usize;
                _nrisk += 1;
                let zbeta = self.offset[person_i]
                    + beta
                        .iter()
                        .enumerate()
                        .fold(0.0, |acc, (i, &b)| acc + b * self.covar[(person_i, i)]);
                let risk = zbeta.exp() * self.weights[person_i];
                if self.status[person_i] == 0 {
                    denom += risk;
                    #[allow(clippy::needless_range_loop)]
                    for i in 0..nvar {
                        a[i] += risk * self.covar[(person_i, i)];
                        for j in 0..=i {
                            cmat[(i, j)] +=
                                risk * self.covar[(person_i, i)] * self.covar[(person_i, j)];
                        }
                    }
                } else {
                    ndead += 1;
                    deadwt += self.weights[person_i];
                    denom2 += risk;
                    loglik += self.weights[person_i] * zbeta;
                    #[allow(clippy::needless_range_loop)]
                    for i in 0..nvar {
                        self.u[i] += self.weights[person_i] * self.covar[(person_i, i)];
                        a2[i] += risk * self.covar[(person_i, i)];
                        for j in 0..=i {
                            cmat2[(i, j)] +=
                                risk * self.covar[(person_i, i)] * self.covar[(person_i, j)];
                        }
                    }
                }
                person -= 1;
                if person >= 0 && self.strata[person as usize] == 1 {
                    break;
                }
            }
            if ndead > 0 {
                match method {
                    Method::Breslow => {
                        denom += denom2;
                        loglik -= deadwt * denom.ln();
                        #[allow(clippy::needless_range_loop)]
                        for i in 0..nvar {
                            a[i] += a2[i];
                            let temp = a[i] / denom;
                            self.u[i] -= deadwt * temp;
                            for j in 0..=i {
                                cmat[(i, j)] += cmat2[(i, j)];
                                let val = deadwt * (cmat[(i, j)] - temp * a[j]) / denom;
                                self.imat[(j, i)] += val;
                                if i != j {
                                    self.imat[(i, j)] += val;
                                }
                            }
                        }
                    }
                    Method::Efron => {
                        let wtave = deadwt / ndead as f64;
                        for k in 0..ndead {
                            let _kf = k as f64;
                            denom += denom2 / ndead as f64;
                            loglik -= wtave * denom.ln();
                            for i in 0..nvar {
                                a[i] += a2[i] / ndead as f64;
                                let temp = a[i] / denom;
                                self.u[i] -= wtave * temp;
                                for j in 0..=i {
                                    cmat[(i, j)] += cmat2[(i, j)] / ndead as f64;
                                    let val = wtave * (cmat[(i, j)] - temp * a[j]) / denom;
                                    self.imat[(j, i)] += val;
                                    if i != j {
                                        self.imat[(i, j)] += val;
                                    }
                                }
                            }
                        }
                    }
                }
                a2.fill(0.0);
                cmat2.fill(0.0);
            }
        }
        Ok(loglik)
    }
    pub fn fit(&mut self) -> Result<(), CoxError> {
        let nvar = self.beta.len();
        let mut newbeta = vec![0.0; nvar];
        let mut a = vec![0.0; nvar];
        let mut halving = 0;
        let mut _notfinite;
        let beta_copy = self.beta.clone();
        self.loglik[0] = self.iterate(&beta_copy)?;
        self.loglik[1] = self.loglik[0];
        a.copy_from_slice(&self.u);
        self.flag = Self::cholesky(&mut self.imat, self.toler)?;
        Self::chsolve(&self.imat, &mut a)?;
        self.sctest = a.iter().zip(&self.u).map(|(ai, ui)| ai * ui).sum();
        if self.max_iter == 0 || !self.loglik[0].is_finite() {
            Self::chinv(&mut self.imat)?;
            self.rescale_params();
            return Ok(());
        }
        newbeta.copy_from_slice(&self.beta);
        for i in 0..nvar {
            newbeta[i] += a[i];
        }
        self.loglik[1] = self.loglik[0];
        for iter in 1..=self.max_iter {
            self.iter = iter;
            let newlk = match self.iterate(&newbeta) {
                Ok(lk) if lk.is_finite() => lk,
                _ => {
                    _notfinite = true;
                    f64::NAN
                }
            };
            _notfinite = !newlk.is_finite();
            if !_notfinite {
                for i in 0..nvar {
                    if !self.u[i].is_finite() {
                        _notfinite = true;
                        break;
                    }
                    for j in 0..nvar {
                        if !self.imat[(i, j)].is_finite() {
                            _notfinite = true;
                            break;
                        }
                    }
                }
            }
            if !_notfinite && ((self.loglik[1] - newlk).abs() / newlk.abs() <= self.eps) {
                self.loglik[1] = newlk;
                Self::chinv(&mut self.imat)?;
                self.rescale_params();
                if halving > 0 {
                    self.flag = -2;
                }
                return Ok(());
            }
            if _notfinite || newlk < self.loglik[1] {
                halving += 1;
                for (newbeta_elem, beta_elem) in newbeta.iter_mut().zip(self.beta.iter()).take(nvar)
                {
                    *newbeta_elem =
                        (*newbeta_elem + (halving as f64) * beta_elem) / (halving as f64 + 1.0);
                }
            } else {
                halving = 0;
                self.loglik[1] = newlk;
                self.beta.copy_from_slice(&newbeta);
                a.copy_from_slice(&self.u);
                Self::chsolve(&self.imat, &mut a)?;
                for (newbeta_elem, (beta_elem, a_elem)) in newbeta
                    .iter_mut()
                    .zip(self.beta.iter().zip(a.iter()))
                    .take(nvar)
                {
                    *newbeta_elem = beta_elem + a_elem;
                }
            }
        }
        let beta_final = self.beta.clone();
        self.loglik[1] = self.iterate(&beta_final)?;
        Self::chinv(&mut self.imat)?;
        self.rescale_params();
        self.flag = 1000;
        Ok(())
    }
    fn rescale_params(&mut self) {
        let nvar = self.beta.len();
        for i in 0..nvar {
            self.beta[i] *= self.scale[i];
            self.u[i] /= self.scale[i];
            for j in 0..nvar {
                self.imat[(i, j)] *= self.scale[i] * self.scale[j];
            }
        }
    }
    fn cholesky(mat: &mut Array2<f64>, toler: f64) -> Result<i32, CoxError> {
        let n = mat.nrows();
        #[allow(clippy::needless_range_loop)]
        for i in 0..n {
            for j in (i + 1)..n {
                mat[(i, j)] = mat[(j, i)];
            }
        }
        let mat_clone3 = mat.clone();
        match mat_clone3.cholesky_into(ndarray_linalg::UPLO::Lower) {
            Ok(_) => Ok(n as i32),
            Err(_) => {
                #[allow(clippy::needless_range_loop)]
                for i in 0..n {
                    if mat[(i, i)] < toler {
                        return Ok(i as i32);
                    }
                }
                Err(CoxError::CholeskyDecomposition)
            }
        }
    }
    fn chsolve(chol: &Array2<f64>, a: &mut [f64]) -> Result<(), CoxError> {
        let _n = chol.nrows();
        let b = Array1::from_vec(a.to_vec());
        let result = chol
            .solve(&b)
            .map_err(|_| CoxError::CholeskyDecomposition)?;
        a.copy_from_slice(&result.to_vec());
        Ok(())
    }
    fn chinv(mat: &mut Array2<f64>) -> Result<(), CoxError> {
        let mat_clone = mat.clone();
        let chol = match mat_clone.cholesky_into(ndarray_linalg::UPLO::Lower) {
            Ok(chol) => chol,
            Err(_) => return Err(CoxError::MatrixInversion),
        };
        let inv = match chol.inv() {
            Ok(inv) => inv,
            Err(_) => return Err(CoxError::MatrixInversion),
        };
        *mat = inv;
        Ok(())
    }
    pub fn results(self) -> CoxFitResults {
        (
            self.beta,
            self.means,
            self.u,
            self.imat,
            self.loglik,
            self.sctest,
            self.flag,
            self.iter,
        )
    }
}