protocoll 0.3.1

clojure inspired protocols for rust collections.
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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
use _set::Set;
use std::borrow::Borrow;
use std::slice::{Iter};
use std::vec::IntoIter;
use std::iter::FromIterator;
use std::iter::Peekable;
use std::cmp::{min,max};
use std::cmp::Ordering::{self,Less,Equal,Greater};
use std::ops::{Index,BitOr,BitAnd,BitXor,Sub};
use std::fmt::{Debug,Formatter,Result};

/// an array-set. very efficient for small sets.
///
/// for explanations about the methods, see
/// [`BTreeSet`](https://doc.rust-lang.org/std/collections/struct.BTreeSet.html)
/// and [`Vec`](https://doc.rust-lang.org/std/vec/struct.Vec.html).
#[derive(Default,Clone,PartialEq,Eq,PartialOrd,Ord,Hash)]
pub struct VecSortedSet<T>(Vec<T>);

impl<T> VecSortedSet<T> where T:Ord {
    pub fn new() -> Self
    {VecSortedSet(Vec::new())}

    pub fn with_capacity(n:usize) -> Self
    {VecSortedSet(Vec::with_capacity(n))}

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

    pub fn reserve(&mut self, n:usize)
    {self.0.reserve(n)}

    pub fn shrink_to_fit(&mut self)
    {self.0.shrink_to_fit()}

    pub fn clear(&mut self)
    {self.0.clear()}

    /// O(log(len))
    pub fn contains<Q:?Sized>(&self, e:&Q) -> bool where T:Borrow<Q>, Q:Ord
    {match self.get(e) {Some(_) => true, None => false}}

    /// O(log(len))
    pub fn get<Q:?Sized>(&self, e:&Q) -> Option<&T> where T:Borrow<Q>, Q:Ord
    {match self.0.binary_search_by(|q| q.borrow().cmp(&e))
     {Ok(i) => Some(&self.0[i]), Err(_) => None}}

    /// O(log(len))
    pub fn get_mut<Q:?Sized>(&mut self, e:&Q) -> Option<&mut T> where T:Borrow<Q>, Q:Ord
    {match self.0.binary_search_by(|q| q.borrow().cmp(&e))
     {Ok(i) => Some(&mut self.0[i]), Err(_) => None}}

    /// O(log(len)) when `e` already exists. O(len) for inserting a new element,
    /// caused by shifting all elements after it, which can be avoided by always
    /// inserting in order.
    pub fn insert(&mut self, e:T) -> Option<T>
    {let ref mut vec = self.0;
     match vec.binary_search_by(|q| q.cmp(&e))
     {Ok(i) => {vec.push(e); Some(vec.swap_remove(i))}
      Err(i) => {vec.insert(i,e); None}}}

    /// O(log(len)) when `e` does not exist. O(len) for removing an element,
    /// because of the need for shifting all elements after it.
    pub fn remove<Q:?Sized>(&mut self, e:&Q) -> Option<T> where T:Borrow<Q>, Q:Ord
    {match self.0.binary_search_by(|q| q.borrow().cmp(&e))
     {Ok(i) => Some(self.0.remove(i)), Err(_) => None}}

    pub fn append(&mut self, other:&mut VecSortedSet<T>)
    {self.0.append(&mut other.0)}

    pub fn reserve_exact(&mut self, n:usize)
    {self.0.reserve_exact(n)}

    pub fn pop(&mut self) -> Option<T>
    {self.0.pop()}

    pub fn truncate(&mut self, n:usize)
    {self.0.truncate(n)}

    pub fn retain<F>(&mut self, f:F) where F:FnMut(&T) -> bool
    {self.0.retain(f)}

    pub fn split_off(&mut self, at:usize) -> VecSortedSet<T>
    {VecSortedSet(self.0.split_off(at))}

    pub fn is_disjoint(&self, other:&VecSortedSet<T>) -> bool
    {self.intersection(other).next().is_none()}

    pub fn is_subset(&self, other:&VecSortedSet<T>) -> bool
    {let mut this = self.iter(); let mut that = other.iter();
     let mut opt_x = this.next(); let mut opt_y = that.next();
     loop {match (opt_x,opt_y)
           {(None,_) => return true,
            (Some(_),None) => return false,
            (Some(x),Some(y)) => match x.cmp(y) {
                Less => return false,
                Equal => opt_x = this.next(),
                Greater => ()}}
           opt_y = that.next()}}
    
    pub fn is_superset(&self, other:&VecSortedSet<T>) -> bool
    {other.is_subset(self)}

    pub fn union<'a>(&'a self, other:&'a VecSortedSet<T>) -> Union<'a,T>
    {Union{this:self.iter().peekable(),that:other.iter().peekable()}}

    pub fn intersection<'a>(&'a self, other:&'a VecSortedSet<T>) -> Intersection<'a,T>
    {Intersection{this:self.iter().peekable(),that:other.iter().peekable()}}

    pub fn difference<'a>(&'a self, other:&'a VecSortedSet<T>) -> Difference<'a,T>
    {Difference{this:self.iter().peekable(),that:other.iter().peekable()}}

    pub fn symmetric_difference<'a>(&'a self, other:&'a VecSortedSet<T>) -> SymmetricDifference<'a,T>
    {SymmetricDifference{this:self.iter().peekable(),that:other.iter().peekable()}}
}

impl<T> VecSortedSet<T> {
    /// a view for the underlying vec. `&self` methods for `Vec` such as `get`
    /// and `split` can be accessed through this.
    pub fn view_content<'a>(&'a self) -> &'a Vec<T>
    {&self.0}

    /// iterate over the underlying vec.
    pub fn iter(&self) -> Iter<T>
    {self.0.iter()}

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

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

impl<T> IntoIterator for VecSortedSet<T>
{type Item = T; type IntoIter = IntoIter<T>;
 fn into_iter(self) -> IntoIter<T> {self.0.into_iter()}}

impl<'a,T:'a> IntoIterator for &'a VecSortedSet<T>
{type Item = &'a T; type IntoIter = Iter<'a,T>;
 fn into_iter(self) -> Iter<'a,T> {self.iter()}}

impl<T> Extend<T> for VecSortedSet<T> where T:Ord
{fn extend<I>(&mut self, iter:I) where I:IntoIterator<Item = T>
 {for e in iter {self.insert(e);}}}

impl<'a,T> Extend<(&'a T)> for VecSortedSet<T> where T:Ord+Copy
{fn extend<I>(&mut self, iter:I) where I:IntoIterator<Item = &'a T>
 {self.extend(iter.into_iter().map(|&e| e));}}

impl<T> FromIterator<T> for VecSortedSet<T> where T:Ord
{fn from_iter<I>(iter:I) -> VecSortedSet<T> where I:IntoIterator<Item = T>
 {Set::plus(VecSortedSet::new(),iter)}}

impl<'a,T,Q:?Sized> Index<&'a Q> for VecSortedSet<T> where T:Ord, T:Borrow<Q>, Q:Ord
{type Output = T; fn index(&self, k:&Q) -> &T {self.get(k).expect("no entry found for key")}}

impl<T> Debug for VecSortedSet<T> where T:Ord+Debug
{fn fmt(&self, fmt: &mut Formatter) -> Result
 {fmt.debug_set().entries(self.0.iter()).finish()}}

impl<T> Set<T> for VecSortedSet<T> where T:Ord {
    fn fun<'a,Q:?Sized>(&'a self) -> Box<Fn(&Q) -> Option<&'a T> + 'a> where T:Borrow<Q>, Q:Ord
    {Box::new(move |i| self.get(i))}

    fn inc(mut self, i:T) -> Self
    {self.insert(i); self}

    fn dec<Q:?Sized>(mut self, i:&Q) -> Self where T:Borrow<Q>, Q:Ord
    {self.remove(i); self}

    fn zero(mut self) -> Self
    {self.clear(); self}

    fn shrink(self) -> Self
    {self}
}

impl<T> BitOr<VecSortedSet<T>> for VecSortedSet<T> where T:Ord {
    type Output = VecSortedSet<T>;
    /// union.
    ///
    /// # example
    /// ```
    /// use protocoll::set::VecSortedSet;
    /// let s1:VecSortedSet<_> = vec![1,2,3].into_iter().collect();
    /// let s2:VecSortedSet<_> = vec![2,3,4].into_iter().collect();
    /// assert_eq!((s1 | s2).view_content(), &[1,2,3,4]);
    /// ```
    fn bitor(self, other:VecSortedSet<T>) -> VecSortedSet<T> {
        let mut vec = Vec::new();
        let mut s1 = self.into_iter();
        let mut s2 = other.into_iter();
        let mut opt_e1 = s1.next();
        let mut opt_e2 = s2.next();
        loop {
            let (e1,e2) = match (opt_e1,opt_e2) {
                (None,None) => break,
                (Some(e1),None) => {vec.push(e1); break}
                (None,Some(e2)) => {vec.push(e2); break}
                (Some(e1),Some(e2)) => (e1,e2)
            };
            match e1.cmp(&e2) {
                Less => {opt_e1 = s1.next(); opt_e2 = Some(e2); vec.push(e1)}
                Equal => {opt_e1 = s1.next(); opt_e2 = s2.next(); vec.push(e1)}
                Greater => {opt_e1 = Some(e1); opt_e2 = s2.next(); vec.push(e2)}
            }
        }
        for e in s1 {vec.push(e)}
        for e in s2 {vec.push(e)}
        VecSortedSet(vec)
    }
}

impl<'a,'b,T> BitOr<&'b VecSortedSet<T>> for &'a VecSortedSet<T> where T:Ord+Clone {
    type Output = VecSortedSet<T>;
    /// union with cloned members.
    ///
    /// # example
    /// ```
    /// use protocoll::set::VecSortedSet;
    /// let s1:VecSortedSet<_> = vec![1,2,3].into_iter().collect();
    /// let s2:VecSortedSet<_> = vec![2,3,4].into_iter().collect();
    /// assert_eq!((&s1 | &s2).view_content(), &[1,2,3,4]);
    /// ```
    fn bitor(self, other:&VecSortedSet<T>) -> VecSortedSet<T>
    {self.union(other).cloned().collect()}
}

impl<T> BitAnd<VecSortedSet<T>> for VecSortedSet<T> where T:Ord {
    type Output = VecSortedSet<T>;
    /// intersection.
    ///
    /// # example
    /// ```
    /// use protocoll::set::VecSortedSet;
    /// let s1:VecSortedSet<_> = vec![1,2,3].into_iter().collect();
    /// let s2:VecSortedSet<_> = vec![2,3,4].into_iter().collect();
    /// assert_eq!((s1 & s2).view_content(), &[2,3]);
    /// ```
    fn bitand(self, other:VecSortedSet<T>) -> VecSortedSet<T> {
        let mut vec = Vec::new();
        let mut s1 = self.into_iter();
        let mut s2 = other.into_iter();
        let mut opt_e1 = s1.next();
        let mut opt_e2 = s2.next();
        loop {
            let (e1,e2) = match (opt_e1,opt_e2) {
                (Some(e1),Some(e2)) => (e1,e2),
                _ => break
            };
            match e1.cmp(&e2) {
                Less => {opt_e1 = s1.next(); opt_e2 = Some(e2)}
                Equal => {opt_e1 = s1.next(); opt_e2 = s2.next(); vec.push(e1)}
                Greater => {opt_e1 = Some(e1); opt_e2 = s2.next()}
            }
        }
        VecSortedSet(vec)
    }
}

impl<'a,'b,T> BitAnd<&'b VecSortedSet<T>> for &'a VecSortedSet<T> where T:Ord+Clone {
    type Output = VecSortedSet<T>;
    /// intersection with cloned members.
    ///
    /// # example
    /// ```
    /// use protocoll::set::VecSortedSet;
    /// let s1:VecSortedSet<_> = vec![1,2,3].into_iter().collect();
    /// let s2:VecSortedSet<_> = vec![2,3,4].into_iter().collect();
    /// assert_eq!((&s1 & &s2).view_content(), &[2,3]);
    /// ```
    fn bitand(self, other:&VecSortedSet<T>) -> VecSortedSet<T>
    {self.intersection(other).cloned().collect()}
}


impl<T> Sub<VecSortedSet<T>> for VecSortedSet<T> where T:Ord {
    type Output = VecSortedSet<T>;
    /// difference.
    ///
    /// # example
    /// ```
    /// use protocoll::set::VecSortedSet;
    /// let s1:VecSortedSet<_> = vec![1,2,3].into_iter().collect();
    /// let s2:VecSortedSet<_> = vec![2,3,4].into_iter().collect();
    /// assert_eq!((s1 - s2).view_content(), &[1]);
    /// ```
    fn sub(self, other:VecSortedSet<T>) -> VecSortedSet<T> {
        let mut vec = Vec::new();
        let mut s1 = self.into_iter();
        let mut s2 = other.into_iter();
        let mut opt_e1 = s1.next();
        let mut opt_e2 = s2.next();
        loop {
            let (e1,e2) = match (opt_e1,opt_e2) {
                (None,_) => break,
                (Some(e1),None) => {vec.push(e1); break}
                (Some(e1),Some(e2)) => (e1,e2)
            };
            match e1.cmp(&e2) {
                Less => {opt_e1 = s1.next(); opt_e2 = Some(e2); vec.push(e1)}
                Equal => {opt_e1 = s1.next(); opt_e2 = s2.next()}
                Greater => {opt_e1 = Some(e1); opt_e2 = s2.next()}
            }
        }
        for e in s1 {vec.push(e)}
        VecSortedSet(vec)
    }
}

impl<'a,'b,T> Sub<&'b VecSortedSet<T>> for &'a VecSortedSet<T> where T:Ord+Clone {
    type Output = VecSortedSet<T>;
    /// difference with cloned members.
    ///
    /// # example
    /// ```
    /// use protocoll::set::VecSortedSet;
    /// let s1:VecSortedSet<_> = vec![1,2,3].into_iter().collect();
    /// let s2:VecSortedSet<_> = vec![2,3,4].into_iter().collect();
    /// assert_eq!((&s1 - &s2).view_content(), &[1]);
    /// ```
    fn sub(self, other:&VecSortedSet<T>) -> VecSortedSet<T>
    {self.difference(other).cloned().collect()}
}

impl<T> BitXor<VecSortedSet<T>> for VecSortedSet<T> where T:Ord {
    type Output = VecSortedSet<T>;
    /// symmetric difference.
    ///
    /// # example
    /// ```
    /// use protocoll::set::VecSortedSet;
    /// let s1:VecSortedSet<_> = vec![1,2,3].into_iter().collect();
    /// let s2:VecSortedSet<_> = vec![2,3,4].into_iter().collect();
    /// assert_eq!((s1 ^ s2).view_content(), &[1,4]);
    /// ```
    fn bitxor(self, other:VecSortedSet<T>) -> VecSortedSet<T> {
        let mut vec = Vec::new();
        let mut s1 = self.into_iter();
        let mut s2 = other.into_iter();
        let mut opt_e1 = s1.next();
        let mut opt_e2 = s2.next();
        loop {
            let (e1,e2) = match (opt_e1,opt_e2) {
                (None,None) => break,
                (Some(e1),None) => {vec.push(e1); break}
                (None,Some(e2)) => {vec.push(e2); break}
                (Some(e1),Some(e2)) => (e1,e2)
            };
            match e1.cmp(&e2) {
                Less => {opt_e1 = s1.next(); opt_e2 = Some(e2); vec.push(e1)}
                Equal => {opt_e1 = s1.next(); opt_e2 = s2.next()}
                Greater => {opt_e1 = Some(e1); opt_e2 = s2.next(); vec.push(e2)}
            }
        }
        for e in s1 {vec.push(e)}
        for e in s2 {vec.push(e)}
        VecSortedSet(vec)
    }
}

impl<'a,'b,T> BitXor<&'b VecSortedSet<T>> for &'a VecSortedSet<T> where T:Ord+Clone {
    type Output = VecSortedSet<T>;
    /// symmetric difference with cloned members.
    ///
    /// # example
    /// ```
    /// use protocoll::set::VecSortedSet;
    /// let s1:VecSortedSet<_> = vec![1,2,3].into_iter().collect();
    /// let s2:VecSortedSet<_> = vec![2,3,4].into_iter().collect();
    /// assert_eq!((&s1 ^ &s2).view_content(), &[1,4]);
    /// ```
    fn bitxor(self, other:&VecSortedSet<T>) -> VecSortedSet<T>
    {self.symmetric_difference(other).cloned().collect()}
}

// stolen from BTreeSet, from here downward.
fn cmp_opt<T:Ord>(x:Option<&T>,y:Option<&T>,short:Ordering,long:Ordering) -> Ordering
{match (x, y) {(None,_) => short, (_,None) => long, (Some(x1),Some(y1)) => x1.cmp(y1)}}

#[derive(Clone)]
pub struct Union<'a,T:'a>
{this:Peekable<Iter<'a,T>>,that:Peekable<Iter<'a,T>>}

impl<'a,T> Iterator for Union<'a,T> where T:Ord
{type Item = &'a T;
 fn next(&mut self) -> Option<&'a T>
 {loop {match cmp_opt(self.this.peek(),self.that.peek(),Greater,Less)
        {Less => return self.this.next(),
         Equal => {self.that.next(); return self.this.next()}
         Greater => return self.that.next()}}}
 fn size_hint(&self) -> (usize,Option<usize>)
 {let a = self.this.len(); let b = self.that.len(); (max(a,b),Some(a+b))}}

#[derive(Clone)]
pub struct Intersection<'a,T:'a>
{this:Peekable<Iter<'a,T>>,that:Peekable<Iter<'a,T>>}

impl<'a,T> Iterator for Intersection<'a,T> where T:Ord
{type Item = &'a T;
 fn next(&mut self) -> Option<&'a T>
 {loop {let cmp = match (self.this.peek(),self.that.peek())
        {(None,_) => return None,
         (_,None) => return None,
         (Some(e1),Some(e2)) => e1.cmp(e2)};
        match cmp
        {Less => {self.this.next();}
         Equal => {self.that.next(); return self.this.next()}
         Greater => {self.that.next();}}}}
 fn size_hint(&self) -> (usize,Option<usize>)
 {(0,Some(min(self.this.len(),self.that.len())))}}

#[derive(Clone)]
pub struct Difference<'a,T:'a>
{this:Peekable<Iter<'a,T>>,that:Peekable<Iter<'a,T>>}

impl<'a,T> Iterator for Difference<'a,T> where T:Ord
{type Item = &'a T;
 fn next(&mut self) -> Option<&'a T>
 {loop {match cmp_opt(self.this.peek(),self.that.peek(),Less,Less)
        {Less => return self.this.next(),
         Equal => {self.this.next(); self.that.next();}
         Greater => {self.that.next();}}}}
 fn size_hint(&self) -> (usize,Option<usize>)
 {let a = self.this.len(); let b = self.that.len(); (a.saturating_sub(b),Some(a))}}

#[derive(Clone)]
pub struct SymmetricDifference<'a,T:'a>
{this:Peekable<Iter<'a,T>>,that:Peekable<Iter<'a,T>>}

impl<'a,T> Iterator for SymmetricDifference<'a,T> where T:Ord
{type Item = &'a T;
 fn next(&mut self) -> Option<&'a T>
 {loop {match cmp_opt(self.this.peek(),self.that.peek(),Greater,Less)
        {Less => return self.this.next(),
         Equal => {self.this.next(); self.that.next();}
         Greater => return self.that.next()}}}
 fn size_hint(&self) -> (usize,Option<usize>)
 {(0,Some(self.this.len()+self.that.len()))}}