fg-stitch-lib 0.1.2

Stitch aligner implementation and supporting utilities.
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

/// A `HashMap` where the keys are `usize`s and values can be anything.
///
/// Uses a `Vec` internally to store the values, up to the maximum key size seen so far.  This
/// provides performance for get, put, and contain operations.
pub(crate) struct IndexMap<T> {
    data: Vec<Option<T>>,
    total_added: usize,
}

#[allow(dead_code)]
impl<T> IndexMap<T> {
    pub fn new(max_index: usize) -> Self {
        Self {
            data: (0..=max_index)
                .map(|_| None::<T>)
                .collect::<Vec<Option<T>>>(),
            total_added: 0,
        }
    }

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

    pub fn is_empty(&self) -> bool {
        self.total_added == 0
    }

    pub fn keys(&self) -> impl Iterator<Item = usize> + '_ {
        self.data
            .iter()
            .enumerate()
            .filter_map(|(i, v)| if v.is_none() { None } else { Some(i) })
    }

    pub fn values(&self) -> impl Iterator<Item = &T> + '_ {
        self.data.iter().flatten()
    }

    pub fn contains(&self, index: usize) -> bool {
        self.get(index).is_some()
    }

    #[inline(always)]
    pub fn contains_u32(&self, index: u32) -> bool {
        self.contains(index as usize)
    }

    pub fn get(&self, index: usize) -> Option<&T> {
        if index < self.data.len() {
            self.data[index].as_ref()
        } else {
            None
        }
    }

    #[inline(always)]
    pub fn get_u32(&self, index: u32) -> Option<&T> {
        self.get(index as usize)
    }

    pub fn put(&mut self, index: usize, value: T) {
        if self.data.len() <= index {
            self.reserve(index + 1);
        }
        if self.data[index].is_none() {
            self.total_added += 1;
        }
        self.data[index] = Some(value);
    }

    #[inline(always)]
    pub fn put_u32(&mut self, index: u32, value: T) {
        self.put(index as usize, value);
    }

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

    pub fn reserve(&mut self, capacity: usize) {
        while self.capacity() < capacity {
            self.data.push(None);
        }
    }
}

// Tests
#[cfg(test)]
pub mod tests {
    use itertools::Itertools;
    use rstest::rstest;

    use crate::util::index_map::IndexMap;

    #[rstest]
    fn test_new_empty() {
        let imap = IndexMap::<usize>::new(12);
        assert_eq!(imap.len(), 0);
        assert!(imap.is_empty());
        assert!(imap.keys().collect_vec().is_empty());
        assert!(imap.values().collect_vec().is_empty());
        assert_eq!(imap.capacity(), 13);
    }

    #[rstest]
    fn test_put_and_get() {
        let mut imap = IndexMap::<usize>::new(4);

        imap.put(1, 2);
        assert_eq!(imap.len(), 1);
        assert!(!imap.is_empty());
        assert_eq!(imap.keys().collect_vec(), vec![1]);
        assert_eq!(imap.values().collect_vec(), vec![&2]);
        assert_eq!(imap.capacity(), 5);
        assert_eq!(imap.get(0), None);
        assert_eq!(imap.get(1), Some(&2));
        assert_eq!(imap.get(2), None);
        assert_eq!(imap.get(3), None);

        imap.put(10, 4);
        assert_eq!(imap.len(), 2);
        assert!(!imap.is_empty());
        assert_eq!(imap.keys().collect_vec(), vec![1, 10]);
        assert_eq!(imap.values().collect_vec(), vec![&2, &4]);
        assert_eq!(imap.capacity(), 11);
        assert_eq!(imap.get(0), None);
        assert_eq!(imap.get(1), Some(&2));
        assert_eq!(imap.get(2), None);
        assert_eq!(imap.get(3), None);
        assert_eq!(imap.get(10), Some(&4));

        imap.reserve(11);
        assert_eq!(imap.capacity(), 11);

        imap.reserve(12);
        assert_eq!(imap.capacity(), 12);
        assert_eq!(imap.get(11), None);

        imap.put(11, 124);
        assert_eq!(imap.get(11), Some(&124));
    }
}