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
use contrail::StableArray;
use contrail::StorageMode;
use contrail::Trail;
use contrail::TrailBuilder;
use contrail::Value;

/// A specialized data structure for storing subsets of the range `0..n`.
#[derive(Clone, Copy)]
pub struct SparseSet<M> {
    values: StableArray<usize>,
    positions: StableArray<usize>,
    len: Value<M, usize>,
}

impl<M> SparseSet<M>
where
    M: StorageMode,
{
    /// Creates a new `SparseSet` initialized with the values `0..len`.
    ///
    /// # Examples
    ///
    /// ```
    /// use contrail_collections::TrailedSparseSet;
    /// use contrail::TrailBuilder;
    ///
    /// let mut builder = TrailBuilder::new();
    /// let sparse_set = TrailedSparseSet::new_full(&mut builder, 10);
    /// let mut trail = builder.finish();
    ///
    /// assert_eq!(sparse_set.len(&trail), 10);
    /// ```
    pub fn new_full(builder: &mut TrailBuilder, len: usize) -> Self {
        Self {
            values: StableArray::new(builder, 0..len),
            positions: StableArray::new(builder, 0..len),
            len: Value::new(builder, len),
        }
    }

    /// Returns an iterator over the elements of the `SparseSet` in arbitrary
    /// order.
    ///
    /// # Examples
    ///
    /// ```
    /// use contrail_collections::TrailedSparseSet;
    /// use contrail::TrailBuilder;
    ///
    /// // create a sparse set initialized with the values 0..10
    /// let mut builder = TrailBuilder::new();
    /// let sparse_set = TrailedSparseSet::new_full(&mut builder, 10);
    /// let mut trail = builder.finish();
    ///
    /// // remove some values
    /// sparse_set.remove(&mut trail, 2);
    /// sparse_set.remove(&mut trail, 3);
    /// sparse_set.remove(&mut trail, 6);
    ///
    /// for value in sparse_set.iter(&trail) {
    ///     assert!(value != 2 && value != 3 && value != 6);
    /// }
    /// ```
    #[inline(always)]
    pub fn iter<'s, 't: 's>(&'s self, trail: &'t Trail) -> impl Iterator<Item = usize> + 's {
        (0..self.values.len())
            .map(move |i| self.values.get(trail, i))
            .take(self.len.get(trail))
    }

    #[inline(always)]
    pub fn len(&self, trail: &Trail) -> usize {
        self.len.get(trail)
    }

    #[inline(always)]
    pub fn is_empty(&self, trail: &Trail) -> bool {
        self.len.get(trail) == 0
    }

    #[inline(always)]
    pub fn contains(&self, trail: &Trail, val: usize) -> bool {
        val < self.positions.len() && self.positions.get(trail, val) < self.len.get(trail)
    }

    #[inline(always)]
    pub fn remove(&self, trail: &mut Trail, val: usize) {
        if self.contains(trail, val) {
            let position = self.positions.get(trail, val);
            let new_size = self.len.get(trail) - 1;
            self.swap(trail, position, new_size);
            self.len.set(trail, new_size);
        }
    }

    /// Filters the elements in the sparse set according to the predicate
    /// function.
    ///
    /// # Examples
    ///
    /// ```
    /// use contrail_collections::TrailedSparseSet;
    /// use contrail::TrailBuilder;
    ///
    /// // create a sparse set initialized with the values 0..10
    /// let mut builder = TrailBuilder::new();
    /// let sparse_set = TrailedSparseSet::new_full(&mut builder, 10);
    /// let mut trail = builder.finish();
    ///
    /// // keep only the odd numbers
    /// sparse_set.filter(&mut trail, |x| x % 2 == 1);
    ///
    /// // make sure we kept only the odd numbers
    /// let mut values = sparse_set.iter(&trail).collect::<Vec<_>>();
    /// // we have to sort the values because a sparse set is unordered
    /// values.sort();
    /// assert_eq!(values, vec![1, 3, 5, 7, 9]);
    /// ```
    pub fn filter(&self, trail: &mut Trail, f: impl Fn(usize) -> bool) {
        for position in (0..self.len.get(trail)).rev() {
            let val = self.values.get(trail, position);
            if !f(val) {
                let new_size = self.len.get(trail) - 1;
                self.swap(trail, position, new_size);
                self.len.set(trail, new_size);
            }
        }
    }

    /// Intersects the sparse set with the given values.
    ///
    /// # Examples
    ///
    /// ```
    /// use contrail_collections::TrailedSparseSet;
    /// use contrail::TrailBuilder;
    ///
    /// // create a sparse set initialized with the elements 0..10
    /// let mut builder = TrailBuilder::new();
    /// let sparse_set = TrailedSparseSet::new_full(&mut builder, 10);
    /// let mut trail = builder.finish();
    ///
    /// // keep only the fibonacci numbers
    /// sparse_set.intersect(&mut trail, vec![0, 1, 1, 2, 3, 5, 8, 13]);
    ///
    /// // make sure we kept only the fibonacci numbers
    /// let mut values = sparse_set.iter(&trail).collect::<Vec<_>>();
    /// // we have to sort the values because a sparse set is unordered
    /// values.sort();
    /// assert_eq!(values, vec![0, 1, 2, 3, 5, 8]);
    /// ```
    #[inline(always)]
    pub fn intersect(&self, trail: &mut Trail, vals: impl IntoIterator<Item = usize>) {
        let mut vals = vals.into_iter().collect::<Vec<_>>();
        vals.sort();
        vals.dedup();
        let mut new_size = 0;
        for val in vals {
            if self.contains(trail, val) {
                let position = self.positions.get(trail, val);
                self.swap(trail, position, new_size);
                new_size += 1;
            }
        }
        self.len.set(trail, new_size);
    }

    #[inline(always)]
    fn swap(&self, trail: &mut Trail, i: usize, j: usize) {
        let val_i = self.values.get(trail, i);
        let val_j = self.values.get(trail, j);

        self.values.set(trail, i, val_j);
        self.values.set(trail, j, val_i);

        self.positions.set(trail, val_i, j);
        self.positions.set(trail, val_j, i);
    }
}

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

    use contrail::TrailBuilder;
    use contrail::Trailed;

    #[test]
    fn test() {
        let mut builder = TrailBuilder::new();

        // 0..5
        let trailed_sparse_set = SparseSet::<Trailed>::new_full(&mut builder, 5);

        let trail = &mut builder.finish();

        trail.new_level();

        trailed_sparse_set.remove(trail, 1);
        assert!(!trailed_sparse_set.contains(trail, 1));

        trail.new_level();

        trailed_sparse_set.remove(trail, 4);
        assert!(!trailed_sparse_set.contains(trail, 4));

        trailed_sparse_set.remove(trail, 2);

        assert!(!trailed_sparse_set.contains(trail, 4));

        trail.new_level();

        trailed_sparse_set.remove(trail, 0);
        assert!(!trailed_sparse_set.contains(trail, 0));

        trail.backtrack();

        assert!(trailed_sparse_set.contains(trail, 0));

        trail.backtrack();

        assert!(trailed_sparse_set.contains(trail, 4));
        assert!(trailed_sparse_set.contains(trail, 2));

        trail.backtrack();

        assert!(trailed_sparse_set.contains(trail, 1));
    }
}