fast-stats 0.1.1

Rust library for efficient calculation of statistics from streaming data
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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
use std::f64;
use std::ops::{Bound, RangeBounds};

#[derive(Default, Debug)]
pub struct Stats {
    data: Vec<f64>,
    length: usize,
    sum: f64,
    sum_of_squares: f64,
    max: Option<f64>,
    min: Option<f64>,
}

impl Stats {
    pub fn new() -> Self {
        Default::default()
    }

    fn add_cache(&mut self, x: f64) {
        self.sum += x;
        self.sum_of_squares += x * x;
        self.length += 1;

        if self.max.is_none() || self.max < Some(x) {
            self.max = Some(x)
        };
        if self.min.is_none() || self.min > Some(x) {
            self.min = Some(x)
        };
    }

    fn del_cache(&mut self, x: f64) {
        self.sum -= x;
        self.sum_of_squares -= x * x;
        self.length -= 1;
        
        if self.length == 0 {
            self.max = None;
            self.min = None;
        } else if self.length == 1 {
            self.max = Some(self.data[0]);
            self.min = Some(self.data[0]);
        } else if self.max == Some(x) || self.min == Some(x) {
            let i = self.length - 1;
            self.max = Some(self.data[i]);
            self.min = Some(self.data[i]);
            for j in (0..i).rev() {
                if self.max < Some(self.data[j]) {
                    self.max = Some(self.data[j])
                };
                if self.min > Some(self.data[j]) {
                    self.min = Some(self.data[j])
                };
            }
        }
    }

    pub fn reset(&mut self) {
        self.data = vec![];
        self.length = 0;
        self.sum = 0.0;
        self.sum_of_squares = 0.0;
        self.max = None;
        self.min = None;
    }

    pub fn mean(&mut self) -> Option<f64> {
        if self.length > 0 {
            Some(self.sum / self.length as f64)
        } else {
            None
        }
    }

    pub fn stddev(&mut self) -> Option<f64> {
        if self.length > 0 {
            Some(f64::sqrt(f64::max(0.0, 
                self.length as f64 * self.sum_of_squares - self.sum * self.sum) / (self.length * self.length) as f64))
        } else {
            None
        }
    }

    pub fn min(&self) -> Option<f64> {
        if self.length > 0 {
            self.min
        } else {
            None
        }
    }

    pub fn max(&self) -> Option<f64> {
        if self.length > 0 {
            self.max
        } else {
            None
        }
    }

    pub fn append(&mut self, other: &mut [f64]) {
        other.iter().for_each(|x| self.push(*x));
    }

    pub fn count_in_range<R>(&mut self, range: &R) -> [usize; 2] 
    where 
        R: RangeBounds<usize>,
    {
        use Bound::*;
        let start = range.start_bound();
        let end = range.end_bound();
        let start = match start {
            Unbounded => 0,
            Included(s) => *s,
            Excluded(s) => s.saturating_add(1),
        };
        let end = match end {
            Unbounded => self.data.len() - 1,
            Included(&e) => e,
            Excluded(e) => e.saturating_sub(1),
        };
        [start, end - start + 1]    
    }

    pub fn data(&mut self) -> Vec<f64> {
        self.data.to_vec()
    }

    pub fn drain<R>(&mut self, range: R) -> Vec<f64>
    where
        R: RangeBounds<usize>,
    {
        let start = self.count_in_range(&range)[0];
        let count = self.count_in_range(&range)[1];
        let mut del = vec![];
        for _ in 0..count {
            let x = self.remove(start);
            del.push(x);
        }
        del
    }

    pub fn insert(&mut self, index: usize, element: f64) {
        self.data.insert(index, element);
        self.add_cache(element);
    }

    pub fn is_empty(&self) -> bool {
        self.data.is_empty()
    }

    pub fn len(&self) -> usize {
        self.data.len()
    }

    pub fn pop(&mut self) -> Option<f64> {
        let option = self.data.pop();
        if let Some(x) = option {
            self.del_cache(x);
        }
        option
    }

    pub fn push(&mut self, x: f64) {
        self.data.push(x);
        self.add_cache(x);
    }

    pub fn push_vec(&mut self, v: Vec<f64>) {
        v.iter().for_each(|x| self.push(*x));
    }

    pub fn remove(&mut self, index: usize) -> f64 {
        let x = self.data.remove(index);
        self.del_cache(x);
        x
    }

    pub fn resize(&mut self, new_len: usize, value: f64) {
        let old_length = self.length;
        if new_len > old_length {
            for _ in 0..(new_len - old_length) {
                self.push(value);
            } 
        } else if new_len < old_length {
            for _ in new_len..old_length {
                self.pop();
            }
        }
    }

    pub fn splice<R>(&mut self, range: R, replace_with: Vec<f64>) -> Vec<f64> 
    where
        R: RangeBounds<usize>,
    {
        let mut start = self.count_in_range(&range)[0];
        let count = self.count_in_range(&range)[1];
        let mut del = vec![];
        for _ in 0..count {
            let x = self.remove(start);
            del.push(x);
        }
        for x in replace_with.iter() {
            self.insert(start, *x);
            start += 1;
        }
        del
    }

    pub fn split_off(&mut self, at: usize) -> Vec<f64> {
        let length = self.length;
        let mut del = vec![];
        for _ in at..length {
            let x = self.remove(at);
            del.push(x);
        }
        del
    }

    pub fn swap_remove(&mut self, index: usize) -> f64 {
        let x = self.remove(index);
        let last_val = self.data[self.length-1];
        self.insert(index, last_val);
        self.pop();
        x
    }

    pub fn trim(&mut self, index: usize) {
        let length = self.length;
        if index < length {
            for _ in 0..index {
                self.remove(0);
            }
        }
    }

    pub fn truncate(&mut self, len: usize) {
        let length = self.length;
        if len < length {
            for _ in len..length {
                self.remove(len);
            }
        }
    }

}

#[cfg(test)]
mod tests {
    use float_cmp::approx_eq;
    use super::Stats;
    use crate::stats::{mean, stddev, min, max};

    #[test]
    fn reset_test() {
        let mut vfs = Stats::new();
        vfs.push_vec(vec![1.0, 2.0, 3.0]);
        vfs.reset();
        
        assert_eq!(vfs.data(), vec![])
    }
    
    #[test]
    fn mean_test() {
        let vs = vec![1.0, 2.0];
        let mean_s = mean(&vs);
        
        let mut vfs = Stats::new();
        vfs.push(1.0);
        vfs.push(2.0);
        let mean_fs  = vfs.mean();
    
        assert_eq!(mean_s, mean_fs);
    }

    #[test]
    fn stddev_test() {
        let vs = vec![1.0, 2.0];
        let stddev_s = stddev(&vs);
        
        let mut vfs = Stats::new();
        vfs.push(1.0);
        vfs.push(2.0);
        let stddev_fs  = vfs.stddev();
    
        assert_eq!(stddev_s, stddev_fs);
    }

    #[test]
    fn min_max_test() {
        let vs = vec![1.0, 2.0, 3.0];
        let min_s = min(&vs);
        let max_s = max(&vs);
        
        let mut vfs = Stats::new();
        vfs.push_vec(vec![1.0, 2.0, 3.0]);
        let min_fs  = vfs.min();
        let max_fs = vfs.max();
    
        assert_eq!(min_s, min_fs);
        assert_eq!(max_s, max_fs);
    }

    #[test]
    fn append_test() {
        let mut vs = vec![1.0, 2.0, 3.0];
        let new_s = &mut vec![4.0, 3.0, 2.0];
        vs.append(new_s);
        
        let mut vfs = Stats::new();
        vfs.push_vec(vec![1.0, 2.0, 3.0]);
        let new_fs = &mut vec![4.0, 3.0, 2.0];
        vfs.append(new_fs);
    
        assert_eq!(vs, vfs.data());
        assert_eq!(mean(&vs), vfs.mean());
        assert_eq!(stddev(&vs), vfs.stddev());
        assert_eq!(min(&vs), vfs.min());
        assert_eq!(max(&vs), vfs.max());
    }

    #[test]
    fn drain_test() {
        let mut vs = vec![1.0, -2.0, 3.0, -4.0, 1.0, 4.0];
        vs.drain(3..4);
        
        let mut vfs = Stats::new();
        let vf = vec![1.0, -2.0, 3.0, -4.0, 1.0, 4.0];
        vfs.push_vec(vf);
        vfs.drain(3..4);

        assert_eq!(vs, vfs.data);
        assert_eq!(mean(&vs), vfs.mean());
        assert!( approx_eq!(f64, stddev(&vs).unwrap(), vfs.stddev().unwrap(), epsilon = 1e-15) );
        assert_eq!(min(&vs), vfs.min());
        assert_eq!(max(&vs), vfs.max());
    }

    #[test]
    fn insert_test() {
        let mut vs = vec![1.0, 2.0, 3.0];
        vs.insert(1, 4.0);
        
        let mut vfs = Stats::new();
        vfs.push_vec(vec![1.0, 2.0, 3.0]);
        vfs.insert(1, 4.0);

        assert_eq!(vs, vfs.data());
        assert_eq!(mean(&vs), vfs.mean());
        assert_eq!(stddev(&vs), vfs.stddev());
        assert_eq!(min(&vs), vfs.min());
        assert_eq!(max(&vs), vfs.max());
    }

    #[test]
    fn is_empty_test() {
        let vs: Vec<f64> = vec![];
        let bs = vs.is_empty();
        let vfs = Stats::new();
        let bfs = vfs.is_empty();

        assert_eq!(bs, bfs);
    }

    #[test]
    fn len_test() {
        let vs = vec![1.0, 2.0, 3.0];
        let len_s = vs.len();
        
        let mut vfs = Stats::new();
        vfs.push_vec(vec![1.0, 2.0, 3.0]);
        let len_fs = vfs.len();

        assert_eq!(len_s, len_fs)
    }

    #[test]
    fn remove_test() {
        let mut vs = vec![1.0, 2.0, 3.0];
        vs.remove(1);
        
        let mut vfs = Stats::new();
        vfs.push_vec(vec![1.0, 2.0, 3.0]);
        vfs.remove(1);

        assert_eq!(vs, vfs.data());
        assert_eq!(mean(&vs), vfs.mean());
        assert_eq!(stddev(&vs), vfs.stddev());
        assert_eq!(min(&vs), vfs.min());
        assert_eq!(max(&vs), vfs.max());
    }

    #[test]
    pub fn resize_test() {
        let mut vs = vec![1.0, 2.0, 3.0];
        vs.resize(8, 0.0);
        
        let mut vfs = Stats::new();
        vfs.push_vec(vec![1.0, 2.0, 3.0]);
        vfs.resize(8, 0.0);

        assert_eq!(vs, vfs.data); 

        vs.resize(2, 0.0);
        vfs.resize(2, 0.0);

        assert_eq!(vs, vfs.data());
        assert_eq!(mean(&vs), vfs.mean());
        assert_eq!(stddev(&vs), vfs.stddev());
        assert_eq!(min(&vs), vfs.min());
        assert_eq!(max(&vs), vfs.max());       
    }

    #[test]
    fn splice_test() {
        let mut vs = vec![1.0, 2.0, 3.0];
        let new_s = vec![4.0, 5.0, 6.0];
        vs.splice(1..3, new_s);
        
        let mut vfs = Stats::new();
        vfs.push_vec(vec![1.0, 2.0, 3.0]);
        let new_fs = vec![4.0, 5.0, 6.0];
        vfs.splice(1..3, new_fs);
    
        assert_eq!(vs, vfs.data());
        assert_eq!(mean(&vs), vfs.mean());
        assert_eq!(stddev(&vs), vfs.stddev());
        assert_eq!(min(&vs), vfs.min());
        assert_eq!(max(&vs), vfs.max());   
    }

    #[test]
    fn split_off_test() {
        let mut vs = vec![1.0, 2.0, 3.0];
        let del_s = vs.split_off(0);
        
        let mut vfs = Stats::new();
        vfs.push_vec(vec![1.0, 2.0, 3.0]);
        let del_fs = vfs.split_off(0);

        assert_eq!(del_s, del_fs);
        assert_eq!(mean(&vs), vfs.mean());
        assert_eq!(stddev(&vs), vfs.stddev());
        assert_eq!(min(&vs), vfs.min());
        assert_eq!(max(&vs), vfs.max());           
    }

    #[test]
    fn swap_remove_test() {
        let mut vs = vec![1.0, 2.0, 3.0];
        vs.swap_remove(0);
        
        let mut vfs = Stats::new();
        vfs.push_vec(vec![1.0, 2.0, 3.0]);
        vfs.swap_remove(0);

        assert_eq!(vs, vfs.data());
        assert_eq!(mean(&vs), vfs.mean());
        assert_eq!(stddev(&vs), vfs.stddev());
        assert_eq!(min(&vs), vfs.min());
        assert_eq!(max(&vs), vfs.max());  
    }

    #[test]
    fn truncate_test() {
        let mut vs = vec![1.0, 2.0, 3.0];
        vs.truncate(2);
        
        let mut vfs = Stats::new();
        let vf = vec![1.0, 2.0, 3.0];
        vfs.push_vec(vf);
        vfs.truncate(2);

        assert_eq!(vs, vfs.data());
        assert_eq!(mean(&vs), vfs.mean());
        assert_eq!(stddev(&vs), vfs.stddev());
        assert_eq!(min(&vs), vfs.min());
        assert_eq!(max(&vs), vfs.max());  
    }

}