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
use std::{
    cmp::Ordering,
    fmt,
    ops::{Add, Range, RangeInclusive, Sub},
};

use num_traits::One;
use smallvec::SmallVec;

use crate::{
    bit_stream::{ReadSafe, WriteSafe},
    BitStreamRead, BitStreamWrite,
};

/// Set of number stored as a set of non-adjacent, non-overlapping ranges
///
/// For a set with few gaps, this uses much less memory than a standard `BTreeSet`
///
/// ## Types
///
/// `N` is the number of continuous ranges that can be stored without
/// needing to allocate space on the heap
///
/// `I` is the integer used for the elements
#[derive(PartialEq, Eq)]
pub struct RangeList<const N: usize, I> {
    inner: SmallVec<[Range<I>; N]>,
}

impl<const N: usize, I: Copy + fmt::Debug> fmt::Debug for RangeList<N, I>
where
    I: Add<Output = I> + One + PartialEq,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let mut list = f.debug_list();
        for e in &self.inner {
            if e.start + I::one() == e.end {
                list.entry(&e.start);
            } else {
                list.entry(e);
            }
        }
        list.finish()
    }
}

impl<const N: usize, I> Default for RangeList<N, I> {
    fn default() -> Self {
        Self::new()
    }
}

impl<const N: usize, I> RangeList<N, I> {
    /// Create a new sorted set
    pub fn new() -> Self {
        Self {
            inner: SmallVec::new(),
        }
    }

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

impl<const N: usize, I> RangeList<N, I>
where
    I: PartialOrd + Add<Output = I> + One + Copy,
{
    /// Find the insertion spot
    fn find(&self, v: I) -> Result<usize, usize> {
        self.inner.binary_search_by(|x| {
            if v < x.start {
                Ordering::Greater
            } else if v >= x.end {
                Ordering::Less
            } else {
                Ordering::Equal
            }
        })
    }

    /// Check whether the inversion list contains this value
    pub fn contains(&self, v: I) -> bool {
        self.find(v).is_ok()
    }

    /// Insert a new element
    pub fn insert(&mut self, v: I) {
        let v1 = v + I::one();
        if let Some(at) = self.find(v).err() {
            if at == 0 {
                match self.inner.first_mut() {
                    Some(first) if v1 == first.start => first.start = v,
                    _ => self.inner.insert(0, v..v1),
                }
            } else if at == self.inner.len() {
                let last = unsafe { self.inner.get_unchecked_mut(at - 1) };
                if last.end == v {
                    last.end = v + I::one();
                } else {
                    self.inner.push(v..v1);
                }
            } else {
                let (left, right) = self.inner.split_at_mut(at);
                let before = unsafe { left.get_unchecked_mut(at - 1) };
                let after = unsafe { right.get_unchecked_mut(0) };

                if before.end == v {
                    if after.start == v1 {
                        before.end = after.end;
                        self.inner.remove(at);
                    } else {
                        before.end = v;
                    }
                } else if v1 == after.start {
                    after.start = v;
                } else {
                    self.inner.insert(at, v..v1);
                }
            }
        }
    }

    /// Insert multiple elements from an iterator
    pub fn insert_all<It: IntoIterator<Item = I>>(&mut self, items: It) {
        let iter = items.into_iter();
        iter.for_each(|x| self.insert(x));
    }

    /// Clear all elements
    pub fn clear(&mut self) {
        self.inner.clear();
    }

    /// Return an iterator over all *inclusive* ranges
    pub fn min_max_ranges(&self) -> impl Iterator<Item = RangeInclusive<I>> + '_
    where
        I: Sub<Output = I>,
    {
        self.inner.iter().map(|r| r.start..=r.end - I::one())
    }

    pub fn serialize(&mut self, bs: &mut BitStreamWrite)
    where
        I: Sub<Output = I> + WriteSafe,
    {
        bs.write_compressed(self.inner.len() as u16);
        for range in self.min_max_ranges() {
            let min_is_max = range.start() == range.end();
            bs.write_bool(min_is_max);
            bs.write(*range.start());
            if !min_is_max {
                bs.write(*range.end());
            }
        }
    }

    pub fn deserialize(bs: &mut BitStreamRead) -> crate::Result<Self>
    where
        I: ReadSafe,
    {
        let mut list = Self::new();
        for _ in 0..bs.read_compressed::<u16>()? {
            let min_is_max = bs.read_bool()?;
            let min: I = bs.read()?;
            let max = match min_is_max {
                false => bs.read()?,
                true => min,
            };
            // FIXME: this may produce broken lists
            let end = max + I::one();
            list.inner.push(min..end);
        }
        Ok(list)
    }
}

#[cfg(test)]
mod tests {
    use std::mem::size_of;

    use crate::BitStreamWrite;

    use super::RangeList;

    #[test]
    fn size() {
        assert_eq!(size_of::<RangeList<1, u32>>(), 24);
    }

    #[test]
    fn serialize() {
        let mut list: RangeList<1, u32> = Default::default();
        let mut bs = BitStreamWrite::new();
        list.serialize(&mut bs)
    }

    #[test]
    #[allow(clippy::single_range_in_vec_init)]
    fn insert() {
        let mut list: RangeList<1, i32> = Default::default();
        list.insert(1);
        assert_eq!(&list.inner[..], &[1..2]);
        assert_eq!(list.find(2), Err(1));
        list.insert(2);
        assert_eq!(&list.inner[..], vec![1..3]);
        assert_eq!(list.find(5), Err(1));
        list.insert(5);
        assert_eq!(&list.inner[..], &[1..3, 5..6]);
        list.insert(6);
        assert_eq!(&list.inner[..], &[1..3, 5..7]);
        list.insert(8);
        assert_eq!(&list.inner[..], &[1..3, 5..7, 8..9]);
        list.insert(10);
        assert_eq!(&list.inner[..], &[1..3, 5..7, 8..9, 10..11]);
        list.insert(4);
        assert_eq!(&list.inner[..], &[1..3, 4..7, 8..9, 10..11]);
        list.insert(0);
        assert_eq!(&list.inner[..], &[0..3, 4..7, 8..9, 10..11]);
        list.insert(3);
        assert_eq!(&list.inner[..], &[0..7, 8..9, 10..11]);
        list.insert(9);
        assert_eq!(&list.inner[..], &[0..7, 8..11]);
        list.insert(9);
        assert_eq!(&list.inner[..], &[0..7, 8..11]);
        list.insert(7);
        assert_eq!(&list.inner[..], &[0..11]);
    }
}