sfs-core 0.1.0

Core implementation of tools for working with site frequency spectra
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

//! Spectrum iterators.
//!
//! The types in this module are constructed via methods on [`Spectrum`],
//! and generally expose no functionality other than being iterable.

use std::iter::FusedIterator;

use crate::array::iter::IndicesIter;

use super::{Spectrum, State};

/// An iterator over the allele frequencies corresponding to the indices of a [`Spectrum`].
///
/// See [`Spectrum::iter_frequencies`] for details.
#[derive(Debug)]
pub struct FrequenciesIter<'a> {
    inner: IndicesIter<'a>,
}

impl<'a> FrequenciesIter<'a> {
    pub(super) fn new<S: State>(spectrum: &'a Spectrum<S>) -> Self {
        Self {
            inner: spectrum.array.iter_indices(),
        }
    }
}

impl<'a> Iterator for FrequenciesIter<'a> {
    type Item = Vec<f64>;

    fn next(&mut self) -> Option<Self::Item> {
        self.inner.next().map(|indices| {
            indices
                .iter()
                .zip(self.inner.shape().iter())
                .map(|(&i, n)| i as f64 / (n - 1) as f64)
                .collect()
        })
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        self.inner.size_hint()
    }
}

impl<'a> ExactSizeIterator for FrequenciesIter<'a> {}

impl<'a> FusedIterator for FrequenciesIter<'a> {}

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

    #[test]
    fn test_iter_frequencies_2d() {
        let spectrum = Spectrum::from_zeros([2, 3]);
        let mut iter = spectrum.iter_frequencies();

        assert_eq!(iter.len(), 6);

        assert_eq!(iter.next(), Some(vec![0., 0.]));
        assert_eq!(iter.next(), Some(vec![0., 0.5]));
        assert_eq!(iter.next(), Some(vec![0., 1.]));

        assert_eq!(iter.len(), 3);

        assert_eq!(iter.next(), Some(vec![1., 0.]));
        assert_eq!(iter.next(), Some(vec![1., 0.5]));
        assert_eq!(iter.next(), Some(vec![1., 1.]));

        assert_eq!(iter.len(), 0);
        assert!(iter.next().is_none());
    }
}