vertree 0.2.2

A persistent trie where each node is typed and versioned
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

use std::collections::hash_map::RandomState;
use std::collections::hash_set::{self, HashSet};
use std::fmt;

#[derive(Clone, Debug, Eq, PartialEq, Default, Serialize, Deserialize)]
pub struct Set {
    pub data: HashSet<Vec<u8>>
}

/// An abstract set datatype
impl Set {
    pub fn new() -> Set {
        Set { data: HashSet::new() }
    }

    pub fn with_capacity(size: usize) -> Set {
        Set { data: HashSet::with_capacity(size) }
    }

    pub fn fill(data: HashSet<Vec<u8>>) -> Set {
        Set { data: data }
    }

    /// Insert an element into the set.
    /// Returns `true` if the element was added, and `false` if it already
    /// existed in the set.
    pub fn insert(&mut self, element: Vec<u8>) -> bool {
        self.data.insert(element)
    }

    /// Remove the element from the set
    /// Returns `true` if the value was present in the set, `false` otherwise
    pub fn remove(&mut self, element: &[u8]) -> bool {
        self.data.remove(element)
    }

    /// Returns `true` if the element is in the set
    pub fn contains(&self, element: &[u8]) -> bool {
        self.data.contains(element)
    }

    /// Returns the number of elements in the Set
    pub fn len(&self) -> usize {
        self.data.len()
    }

    /// Returns `true` if the `Set` is empty
    pub fn is_empty(&self) -> bool {
        self.data.is_empty()
    }


    /// Returns the union of two sets
    ///
    /// # Examples
    ///
    /// ```
    /// use vertree::containers::Set;
    ///
    /// let a = Set { data: vec![vec![1],
    ///                          vec![2],
    ///                          vec![3]].into_iter().collect() };
    /// let b = Set { data: vec![vec![1],
    ///                          vec![2],
    ///                          vec![3],
    ///                          vec![4]].into_iter().collect() };
    ///
    /// assert_eq!(Set { data: a.union(&b).cloned().collect() },
    ///            Set { data: vec![vec![1],
    ///                             vec![2],
    ///                             vec![3],
    ///                             vec![4]].into_iter()
    ///                                     .collect() });
    pub fn union<'a>(&'a self, other: &'a Set) -> Union<'a> {
        Union {
            iter: self.data.union(&other.data),
        }
    }

    /// Returns the intersection of two sets
    ///
    /// # Examples
    ///
    /// ```
    /// use vertree::containers::Set;
    ///
    /// let a = Set { data: vec![vec![1],
    ///                          vec![2],
    ///                          vec![3]].into_iter().collect() };
    /// let b = Set { data: vec![vec![2],
    ///                          vec![3],
    ///                          vec![4]].into_iter().collect() };
    ///
    /// let result = Set { data: a.intersection(&b).cloned().collect() };
    /// assert_eq!(result, Set { data: vec![vec![2],
    ///                                     vec![3]].into_iter().collect() });
    pub fn intersection<'a>(&'a self, other: &'a Set) -> Intersection<'a> {
        Intersection {
            iter: self.data.intersection(&other.data),
        }
    }

    /// Returns the difference between two sets
    ///
    /// The difference is seen as `self - other`, which is all the keys in
    /// `self` that don't exist
    /// in `other`.
    ///
    /// # Examples
    ///
    /// ```
    /// use vertree::containers::Set;
    ///
    /// let a = Set { data: vec![vec![1],
    ///                          vec![2],
    ///                          vec![3]].into_iter().collect() };
    /// let b = Set { data: vec![vec![2],
    ///                          vec![3],
    ///                          vec![4]].into_iter().collect() };
    ///
    /// let result = Set { data: a.difference(&b).cloned().collect() };
    /// assert_eq!(result, Set { data: vec![vec![1]].into_iter().collect() });
    pub fn difference<'a>(&'a self, other: &'a Set) -> Difference<'a> {
        Difference {
            iter: self.data.difference(&other.data),
        }
    }

    /// Returns the symmetric difference between two sets
    ///
    /// The difference is seen as the union of `self - other`, and `other -
    /// self`, which is all the
    /// keys that don't exist in both sets.
    ///
    /// # Examples
    ///
    /// ```
    /// use vertree::containers::Set;
    ///
    /// let a = Set { data: vec![vec![1],
    ///                          vec![2],
    ///                          vec![3]].into_iter().collect() };
    /// let b = Set { data: vec![vec![2],
    ///                          vec![3],
    ///                          vec![4]].into_iter().collect() };
    ///
    /// let result_a = Set { data: a.symmetric_difference(&b)
    ///                             .cloned()
    ///                             .collect() };
    /// let result_b = Set { data: b.symmetric_difference(&a)
    ///                             .cloned()
    ///                             .collect() };
    /// assert_eq!(result_a, result_b);
    /// assert_eq!(result_a,
    ///            Set { data: vec![vec![1], vec![4]].into_iter().collect() });
    pub fn symmetric_difference<'a>(&'a self, other: &'a Set) -> SymmetricDifference<'a> {
        SymmetricDifference {
            iter: self.data.symmetric_difference(&other.data),
        }
    }

    /// Returns `true` if `self` is a subset of `other`
    pub fn is_subset(&self, other: &Set) -> bool {
        self.data.is_subset(&other.data)
    }

    /// Returns `true` if `self` is a subset of `other`
    pub fn is_superset(&self, other: &Set) -> bool {
        self.data.is_superset(&other.data)
    }
}

/// A lazy iterator producing elements in the union of `Set`s.
///
/// This `struct` is created by the [`union`] method on
/// [`Set`]. See its documentation for more.
///
/// [`Set`]: struct.Set.html
/// [`union`]: struct.Set.html#method.union
#[derive(Clone)]
pub struct Union<'a> {
    iter: hash_set::Union<'a, Vec<u8>, RandomState>,
}

impl<'a> fmt::Debug for Union<'a> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        self.iter.fmt(f)
    }
}

impl<'a> Iterator for Union<'a> {
    type Item = &'a Vec<u8>;

    fn next(&mut self) -> Option<Self::Item> {
        self.iter.next()
    }
    fn size_hint(&self) -> (usize, Option<usize>) {
        self.iter.size_hint()
    }
}

/// A lazy iterator producing elements in the intersection of `Set`s.
///
/// This `struct` is created by the [`intersection`] method on
/// [`Set`]. See its documentation for more.
///
/// [`Set`]: struct.Set.html
/// [`intersection`]: struct.Set.html#method.intersection
#[derive(Clone)]
pub struct Intersection<'a> {
    iter: hash_set::Intersection<'a, Vec<u8>, RandomState>,
}

impl<'a> fmt::Debug for Intersection<'a> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        self.iter.fmt(f)
    }
}

impl<'a> Iterator for Intersection<'a> {
    type Item = &'a Vec<u8>;

    fn next(&mut self) -> Option<Self::Item> {
        self.iter.next()
    }
    fn size_hint(&self) -> (usize, Option<usize>) {
        self.iter.size_hint()
    }
}

/// A lazy iterator producing elements in the difference of `Set`s.
///
/// This `struct` is created by the [`difference`] method on
/// [`Set`]. See its documentation for more.
///
/// [`Set`]: struct.Set.html
/// [`difference`]: struct.Set.html#method.difference
#[derive(Clone)]
pub struct Difference<'a> {
    iter: hash_set::Difference<'a, Vec<u8>, RandomState>,
}

impl<'a> fmt::Debug for Difference<'a> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        self.iter.fmt(f)
    }
}

impl<'a> Iterator for Difference<'a> {
    type Item = &'a Vec<u8>;

    fn next(&mut self) -> Option<Self::Item> {
        self.iter.next()
    }
    fn size_hint(&self) -> (usize, Option<usize>) {
        self.iter.size_hint()
    }
}

/// A lazy iterator producing elements in the symmetric difference of `Set`s.
///
/// This `struct` is created by the [`symmetric_difference`] method on
/// [`Set`]. See its documentation for more.
///
/// [`Set`]: struct.Set.html
/// [`symmetric_difference`]: struct.Set.html#method.symmetric_difference
#[derive(Clone)]
pub struct SymmetricDifference<'a> {
    iter: hash_set::SymmetricDifference<'a, Vec<u8>, RandomState>,
}

impl<'a> fmt::Debug for SymmetricDifference<'a> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        self.iter.fmt(f)
    }
}

impl<'a> Iterator for SymmetricDifference<'a> {
    type Item = &'a Vec<u8>;

    fn next(&mut self) -> Option<Self::Item> {
        self.iter.next()
    }
    fn size_hint(&self) -> (usize, Option<usize>) {
        self.iter.size_hint()
    }
}