cantrip 0.5.0

Practical extension methods for standard 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

use std::collections::{BTreeMap, BTreeSet, BinaryHeap, HashMap, HashSet, LinkedList, VecDeque};

use cantrip::{Convert, Map};

use crate::extensions::util::{TestCollection, TestMap, assert_map_equal, assert_set_equal};

#[allow(clippy::too_many_lines)]
pub(crate) fn test_map<'a, C>(a_source: &C, b_source: &C, e_source: &C)
where
  C: TestMap<'a, i64, i64> + Convert<(i64, i64)>,
  C::This<i64, i64>: TestCollection<(i64, i64)>,
  for<'i> &'i C: IntoIterator<Item = (&'i i64, &'i i64)>,
{
  // add
  let a = a_source.clone();
  let e = e_source.clone();
  assert_map_equal(&a.add(4, 4), HashMap::from([(1, 1), (2, 2), (3, 3), (4, 4)]));
  let a = a_source.clone();
  assert_map_equal(&a.add(1, 4), HashMap::from([(1, 4), (2, 2), (3, 3)]));
  assert_map_equal(&e.add(1, 1), HashMap::from([(1, 1)]));

  // add_multi
  let a = a_source.clone();
  let e = e_source.clone();
  assert_map_equal(&a.add_multi(vec![(4, 4), (5, 5)]), HashMap::from([(1, 1), (2, 2), (3, 3), (4, 4), (5, 5)]));
  let a = a_source.clone();
  assert_map_equal(&a.add_multi(vec![(1, 4), (5, 5)]), HashMap::from([(1, 4), (2, 2), (3, 3), (5, 5)]));
  assert_map_equal(&e.add_multi(vec![(1, 1), (2, 2)]), HashMap::from([(1, 1), (2, 2)]));

  // all
  let a = a_source.clone();
  let e = e_source.clone();
  assert!(a.all(|(&k, &v)| k > 0 && v > 0));
  assert!(e.all(|(&k, _)| k > 0));
  assert!(!a.all(|(&k, _)| k > 2));

  // any
  let a = a_source.clone();
  let e = e_source.clone();
  assert!(a.any(|(&k, &v)| k > 0 && v > 1));
  assert!(!a.any(|(&k, _)| k > 5));
  assert!(!e.any(|(&k, _)| k > 0));

  // collect
  assert_eq!(a.collect::<BTreeSet<(i64, i64)>>(), BTreeSet::from([(1, 1), (2, 2), (3, 3)]));
  assert_eq!(e.collect::<BTreeSet<(i64, i64)>>(), BTreeSet::new());

  // count_by
  let a = a_source.clone();
  let e = e_source.clone();
  assert_eq!(a.count_by(|(&k, &v)| k == 2 && v == 2), 1);
  assert_eq!(a.count_by(|(&k, _)| k == 5), 0);
  assert_eq!(e.count_by(|(&k, _)| k == 5), 0);

  // count_unique
  let b = b_source.clone();
  assert_eq!(a.count_unique(), 3);
  assert_eq!(b.count_unique(), 2);
  assert_eq!(e.count_unique(), 0);

  // delete
  let a = a_source.clone();
  let e = e_source.clone();
  assert_map_equal(&a.delete(&2), HashMap::from([(1, 1), (3, 3)]));
  assert_map_equal(&e.delete(&2), HashMap::new());

  // delete_multi
  let a = a_source.clone();
  let e = e_source.clone();
  assert_map_equal(&a.delete_multi(&vec![1, 3]), HashMap::from([(2, 2)]));
  let a = a_source.clone();
  assert_map_equal(&a.delete_multi(&HashMap::from([(1, 1), (3, 3)]).keys()), HashMap::from([(2, 2)]));
  let a = a_source.clone();
  assert_map_equal(&a.delete_multi(&HashMap::from([(1, 1), (3, 3)]).values()), HashMap::from([(2, 2)]));
  assert_map_equal(&e.delete_multi(&vec![1]), HashMap::new());

  // disjoint
  let a = a_source.clone();
  let e = e_source.clone();
  assert!(a.disjoint(&vec![4, 5]));
  assert!(a.disjoint(&vec![]));
  assert!(!a.disjoint(&vec![3, 4]));
  assert!(e.disjoint(&vec![1]));

  // fill_with
  assert_map_equal(&HashMap::fill_with(|| (1, 1), 1), HashMap::from([(1, 1)]));
  assert_map_equal(&HashMap::fill_with(|| (1, 1), 0), HashMap::new());

  // filter
  let a = a_source.clone();
  let e = e_source.clone();
  assert_map_equal(&a.filter(|(&k, &v)| k != 2 && v != 2), HashMap::from([(1, 1), (3, 3)]));
  assert_map_equal(&e.filter(|(&k, &v)| k != 2 && v != 2), HashMap::new());

  // filter_keys
  let a = a_source.clone();
  let e = e_source.clone();
  assert_map_equal(&a.filter_keys(|&k| k != 2), HashMap::from([(1, 1), (3, 3)]));
  assert_map_equal(&e.filter_keys(|&k| k != 2), HashMap::new());

  // filter_values
  let a = a_source.clone();
  let e = e_source.clone();
  assert_map_equal(&a.filter_values(|&v| v != 2), HashMap::from([(1, 1), (3, 3)]));
  assert_map_equal(&e.filter_values(|&v| v != 2), HashMap::new());

  // filter_map
  let a = a_source.clone();
  let e = e_source.clone();
  assert_map_equal(&a.filter_map(|(k, v)| if k < 2 { Some((k, v + 1)) } else { None }), HashMap::from([(1, 2)]));
  assert_map_equal(&e.filter_map(|(k, v)| if k < 2 { Some((k, v + 1)) } else { None }), HashMap::new());

  // filter_map_ref
  let a = a_source.clone();
  let e = e_source.clone();
  assert_map_equal(&a.filter_map_ref(|(&k, &v)| if k < 2 { Some((k, v + 1)) } else { None }), HashMap::from([(1, 2)]));
  assert_map_equal(&e.filter_map_ref(|(&k, &v)| if k < 2 { Some((k, v + 1)) } else { None }), HashMap::new());

  // find
  assert_eq!(a.find(|(&k, &v)| k == 2 && v == 2), Some((&2, &2)));
  assert_eq!(a.find(|(&k, _)| k == 5), None);
  assert_eq!(e.find(|(&k, _)| k == 5), None);

  // find_map
  let a = a_source.clone();
  let e = e_source.clone();
  assert_eq!(a.find_map(|(k, v)| if k == 2 { Some(v) } else { None }), Some(2));
  assert_eq!(e.find_map(|(k, v)| if k == 2 { Some(v) } else { None }), None);

  // find_map_ref
  let a = a_source.clone();
  let e = e_source.clone();
  assert_eq!(a.find_map_ref(|(&k, &v)| if k == 2 { Some(v) } else { None }), Some(2));
  assert_eq!(e.find_map_ref(|(&k, &v)| if k == 2 { Some(v) } else { None }), None);

  // flat_map
  assert_map_equal(
    &a.flat_map(|(k, v)| vec![(-k, v), (k, v)]),
    HashMap::from([(-1, 1), (-2, 2), (-3, 3), (1, 1), (2, 2), (3, 3)]),
  );
  assert_map_equal(&e.flat_map(|(k, v)| vec![(-k, v), (k, v)]), HashMap::new());

  // flat_map_ref
  let a = a_source.clone();
  let e = e_source.clone();
  assert_map_equal(
    &a.flat_map_ref(|(&k, &v)| vec![(-k, v), (k, v)]),
    HashMap::from([(-1, 1), (-2, 2), (-3, 3), (1, 1), (2, 2), (3, 3)]),
  );
  assert_map_equal(&e.flat_map_ref(|(&k, &v)| vec![(-k, v), (k, v)]), HashMap::new());

  // fold
  assert_eq!(a.fold(0, |acc, (k, v)| acc + k + v), 12);
  assert_eq!(e.fold(0, |acc, (k, v)| acc + k + v), 0);

  // fold_ref
  let a = a_source.clone();
  let e = e_source.clone();
  assert_eq!(a.fold_ref(0, |acc, (&k, &v)| acc + k + v), 12);
  assert_eq!(e.fold_ref(0, |acc, (&k, &v)| acc + k + v), 0);

  // for_each
  let mut acc = 0;
  a.for_each(|(&k, &v)| acc += k + v);
  assert_eq!(acc, 12);
  e.for_each(|(&k, &v)| acc += k + v);
  assert_eq!(acc, 12);

  // intersect
  let a = a_source.clone();
  let e = e_source.clone();
  assert_map_equal(&a.intersect(&vec![(4, 4), (2, 2), (3, 4), (4, 5)]), HashMap::from([(2, 2)]));
  assert_map_equal(&e.intersect(&vec![(1, 1)]), HashMap::new());

  // map
  let a = a_source.clone();
  let e = e_source.clone();
  assert_map_equal(&a.map(|(k, v)| (k, k + v)), HashMap::from([(1, 2), (2, 4), (3, 6)]));
  assert_map_equal(&e.map(|(k, v)| (k, k + v)), HashMap::new());

  // map_ref
  let a = a_source.clone();
  let e = e_source.clone();
  assert_map_equal(&a.map_ref(|(&k, &v)| (k, k + v)), HashMap::from([(1, 2), (2, 4), (3, 6)]));
  assert_map_equal(&e.map_ref(|(&k, &v)| (k, k + v)), HashMap::new());

  // map_keys
  assert_map_equal(&a.map_keys(|&k| k + 1), HashMap::from([(2, 1), (3, 2), (4, 3)]));
  assert_map_equal(&e.map_keys(|&k| k + 1), HashMap::new());

  // map_values
  let a = a_source.clone();
  let e = e_source.clone();
  assert_map_equal(&a.map_values(|&v| v + 1), HashMap::from([(1, 2), (2, 3), (3, 4)]));
  assert_map_equal(&e.map_values(|&v| v + 1), HashMap::new());

  // max_by
  let a = a_source.clone();
  let e = e_source.clone();
  assert_eq!(a.max_by(|x, y| x.0.cmp(y.0)), Some((&3, &3)));
  assert_eq!(e.max_by(|x, y| x.0.cmp(y.0)), None);

  // max_by_key
  assert_eq!(a.max_by_key(|(k, _)| -k), Some((&1, &1)));
  assert_eq!(e.max_by_key(|(k, _)| -k), None);

  // max_of
  assert_eq!(a.max_of(), Some((&3, &3)));
  assert_eq!(e.max_of(), None);

  // min_by
  assert_eq!(a.min_by(|x, y| x.0.cmp(y.0)), Some((&1, &1)));
  assert_eq!(e.min_by(|x, y| x.0.cmp(y.0)), None);

  // min_by_key
  assert_eq!(a.min_by_key(|(k, _)| -k), Some((&3, &3)));
  assert_eq!(e.min_by_key(|(k, _)| -k), None);

  // min_of
  assert_eq!(a.min_of(), Some((&1, &1)));
  assert_eq!(e.min_of(), None);

  // minmax_by
  assert_eq!(a.minmax_by(|x, y| x.0.cmp(y.0)), Some(((&1, &1), (&3, &3))));
  assert_eq!(e.minmax_by(|x, y| x.0.cmp(y.0)), None);

  // minmax_by_key
  assert_eq!(a.minmax_by_key(|(k, _)| -k), Some(((&3, &3), (&1, &1))));
  assert_eq!(e.minmax_by_key(|(k, _)| -k), None);

  // minmax_of
  assert_eq!(a.minmax_of(), Some(((&1, &1), (&3, &3))));
  assert_eq!(e.minmax_of(), None);

  // partition
  let a = a_source.clone();
  let e = e_source.clone();
  let (a_even, a_odd) = a.partition(|(&k, _)| k % 2 == 0);
  assert_map_equal(&a_even, HashMap::from([(2, 2)]));
  assert_map_equal(&a_odd, HashMap::from([(1, 1), (3, 3)]));
  let (e_even, e_odd) = e.partition(|(&k, _)| k % 2 == 0);
  assert_map_equal(&e_even, HashMap::new());
  assert_map_equal(&e_odd, HashMap::new());

  // partition_map
  let a = a_source.clone();
  let e = e_source.clone();
  let (a_even, a_odd) = a.partition_map(|(k, v)| if k % 2 == 0 { Ok((k + 3, v)) } else { Err((k, v)) });
  assert_map_equal(&a_even, HashMap::from([(5, 2)]));
  assert_map_equal(&a_odd, HashMap::from([(1, 1), (3, 3)]));
  let (e_even, e_odd) = e.partition_map(|(k, v)| if k % 2 == 0 { Ok((k + 3, v)) } else { Err((k, v)) });
  assert_map_equal(&e_even, HashMap::new());
  assert_map_equal(&e_odd, HashMap::new());

  // partition_map_ref
  let a = a_source.clone();
  let e = e_source.clone();
  let (a_even, a_odd) = a.partition_map_ref(|(&k, &v)| if k % 2 == 0 { Ok((k + 3, v)) } else { Err((k, v)) });
  assert_map_equal(&a_even, HashMap::from([(5, 2)]));
  assert_map_equal(&a_odd, HashMap::from([(1, 1), (3, 3)]));
  let (e_even, e_odd) = e.partition_map_ref(|(&k, &v)| if k % 2 == 0 { Ok((k + 3, v)) } else { Err((k, v)) });
  assert_map_equal(&e_even, HashMap::new());
  assert_map_equal(&e_odd, HashMap::new());

  // product_keys
  assert_eq!(a.product_keys(), 6);
  assert_eq!(e.product_keys(), 1);

  // product_values
  let a = a_source.clone();
  let e = e_source.clone();
  assert_eq!(a.product_values(), 6);
  assert_eq!(e.product_values(), 1);

  // reduce
  let a = a_source.clone();
  let e = e_source.clone();
  assert_eq!(a.reduce(|(a, b), (k, v)| (a + k, b + v)), Some((6, 6)));
  assert_eq!(e.reduce(|(a, b), (k, v)| (a + k, b + v)), None);

  // reduce_ref
  let a = a_source.clone();
  let e = e_source.clone();
  assert_eq!(a.reduce_ref(|(&a, &b), (&k, &v)| (a + k, b + v)), Some((6, 6)));
  assert_eq!(e.reduce_ref(|(&a, &b), (&k, &v)| (a + k, b + v)), None);

  // subset
  assert!(a.subset(&vec![4, 3, 2, 2, 1]));
  assert!(e.subset(&vec![1]));
  assert!(!a.subset(&vec![1, 2]));
  assert!(!a.subset(&vec![]));

  // substitute
  let a = a_source.clone();
  let e = e_source.clone();
  assert_map_equal(&a.substitute(&3, 4, 4), HashMap::from([(1, 1), (2, 2), (4, 4)]));
  assert_map_equal(&e.substitute(&3, 4, 4), HashMap::new());

  // substitute_multi
  let a = a_source.clone();
  let e = e_source.clone();
  assert_map_equal(&a.substitute_multi(&vec![2, 3], vec![(4, 4), (5, 5)]), HashMap::from([(1, 1), (4, 4), (5, 5)]));
  assert_map_equal(&e.substitute_multi(&vec![2, 3], vec![(4, 4), (5, 5)]), HashMap::new());

  // superset
  let a = a_source.clone();
  let e = e_source.clone();
  assert!(a.superset(&vec![3, 1]));
  assert!(a.superset(&vec![]));
  assert!(!a.superset(&vec![1, 2, 3, 4]));
  assert!(!a.superset(&vec![1, 2, 2]));
  assert!(!a.superset(&vec![3, 4]));
  assert!(!e.superset(&vec![1]));

  // sum_keys
  assert_eq!(a.sum_keys(), 6);
  assert_eq!(e.sum_keys(), 0);

  // sum_values
  let a = a_source.clone();
  let e = e_source.clone();
  assert_eq!(a.sum_values(), 6);
  assert_eq!(e.sum_values(), 0);

  // to_bmap
  let a = a_source.clone();
  let e = e_source.clone();
  assert_eq!(a.to_bmap(), BTreeMap::from([(1, 1), (2, 2), (3, 3)]));
  assert_eq!(e.to_bmap(), BTreeMap::new());

  // to_bset
  let a = a_source.clone();
  let e = e_source.clone();
  assert_eq!(a.to_bset(), BTreeSet::from([(1, 1), (2, 2), (3, 3)]));
  assert_eq!(e.to_bset(), BTreeSet::new());

  // to_deque
  let a = a_source.clone();
  let e = e_source.clone();
  assert_set_equal(a.to_deque(), vec![(1, 1), (2, 2), (3, 3)]);
  assert_eq!(e.to_deque(), VecDeque::new());

  // to_heap
  let a = a_source.clone();
  let e = e_source.clone();
  assert_eq!(
    a.to_heap().into_iter().collect::<HashSet<_>>(),
    BinaryHeap::from([(1, 1), (2, 2), (3, 3)]).into_iter().collect()
  );
  assert_eq!(e.to_heap().into_iter().collect::<HashSet<_>>(), BinaryHeap::from([]).into_iter().collect());

  // to_keys
  let a = a_source.clone();
  let e = e_source.clone();
  assert_set_equal(a.to_keys(), vec![1, 2, 3]);
  assert_set_equal(e.to_keys(), vec![]);

  // to_list
  let a = a_source.clone();
  let e = e_source.clone();
  assert_set_equal(a.to_list(), vec![(1, 1), (2, 2), (3, 3)]);
  assert_eq!(e.to_list(), LinkedList::new());

  // to_map
  let a = a_source.clone();
  let e = e_source.clone();
  assert_eq!(a.to_map(), HashMap::from([(1, 1), (2, 2), (3, 3)]));
  assert_eq!(e.to_map(), HashMap::new());

  // to_set
  let a = a_source.clone();
  let e = e_source.clone();
  assert_eq!(a.to_set(), HashSet::from([(1, 1), (2, 2), (3, 3)]));
  assert_eq!(e.to_set(), HashSet::new());

  // to_values
  let a = a_source.clone();
  let e = e_source.clone();
  assert_set_equal(a.to_values(), vec![1, 2, 3]);
  assert_set_equal(e.to_values(), vec![]);

  // to_vec
  let a = a_source.clone();
  let e = e_source.clone();
  assert_set_equal(a.to_vec(), vec![(1, 1), (2, 2), (3, 3)]);
  assert_eq!(e.to_vec(), vec![]);

  // unit
  assert_map_equal(&HashMap::unit(1, 1), HashMap::from([(1, 1)]));
}