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
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
use std::fmt;

use crate::ids::Id;

pub const NUM_BITS: usize = 256;
const BITS_PER_BYTES: usize = 8;

/// Returns "true" if two Ids are equal for the range [start, end).
/// This does bit-per-bit comparison for the Id type of [u8; ID_LEN].
/// ref. <https://pkg.go.dev/github.com/ava-labs/avalanchego/ids#EqualSubset>
pub fn equal_subset(start: usize, end: usize, id1: &Id, id2: &Id) -> bool {
    if end == 0 {
        return true;
    }

    let end = end - 1; // -1 for end index
    if start > end {
        return true;
    }
    if end >= NUM_BITS {
        return false;
    }

    let start_index = (start / BITS_PER_BYTES) as usize;
    let end_index = (end / BITS_PER_BYTES) as usize;

    if start_index + 1 < end_index
        && id1.0[(start_index + 1)..end_index] != id2.0[(start_index + 1)..end_index]
    {
        return false;
    }

    let start_bit = (start % BITS_PER_BYTES) as usize; // index in the byte that the first bit is at
    let end_bit = (end % BITS_PER_BYTES) as usize; // index in the byte that the last bit is at

    let start_mask: i32 = -1 << start_bit; // 111...0... The number of 0s is equal to start_bit
    let end_mask: i32 = (1 << (end_bit + 1)) - 1; // 000...1... The number of 1s is equal to end_bit + 1

    if start_index == end_index {
        // if looking at same byte, both masks need to be applied
        let mask = start_mask & end_mask;

        let b1 = mask & id1.0[start_index] as i32;
        let b2 = mask & id2.0[start_index] as i32;

        return b1 == b2;
    }

    let start1 = start_mask & id1.0[start_index] as i32;
    let start2 = start_mask & id2.0[start_index] as i32;

    let end1 = end_mask & id1.0[end_index] as i32;
    let end2 = end_mask & id2.0[end_index] as i32;

    start1 == start2 && end1 == end2
}

/// RUST_LOG=debug cargo test --package avalanche-types --lib -- ids::bits::test_equal_subset --exact --show-output
#[test]
fn test_equal_subset() {
    // ref. TestEqualSubsetEarlyStop
    let id1 = Id::from_slice(&vec![0xf0, 0x0f]);
    let id2 = Id::from_slice(&vec![0xf0, 0x1f]);
    // for c in &id1.0 {
    //     print!("{:08b} ", *c);
    // }
    // println!("");
    // for c in &id2.0 {
    //     print!("{:08b} ", *c);
    // }
    // big endian - most significant byte first, 0x1 == 00000001
    // 11110000 00001111 00000000 ...
    // 11110000 00011111 00000000 ...

    assert!(equal_subset(0, 12, &id1, &id2));
    assert!(!equal_subset(0, 13, &id1, &id2));

    // ref. TestEqualSubsetLateStart
    let id1 = Id::from_slice(&vec![0x1f, 0xf8]);
    let id2 = Id::from_slice(&vec![0x10, 0x08]);
    // for c in &id1.0 {
    //     print!("{:08b} ", *c);
    // }
    // println!("");
    // for c in &id2.0 {
    //     print!("{:08b} ", *c);
    // }
    // big endian - most significant byte first, 0x1 == 00000001
    // 00011111 11111000 00000000 ...
    // 00010000 00001000 00000000 ...

    assert!(equal_subset(4, 12, &id1, &id2));
    assert!(!equal_subset(4, 13, &id1, &id2));
}

/// RUST_LOG=debug cargo test --package avalanche-types --lib -- ids::bits::test_equal_subset_same_byte --exact --show-output
/// ref. "TestEqualSubsetSameByte"
#[test]
fn test_equal_subset_same_byte() {
    let id1 = Id::from_slice(&vec![0x18]);
    let id2 = Id::from_slice(&vec![0xfc]);
    // for c in &id1.0 {
    //     print!("{:08b} ", *c);
    // }
    // println!("");
    // for c in &id2.0 {
    //     print!("{:08b} ", *c);
    // }
    // big endian - most significant byte first, 0x1 == 00000001
    // 00011000 00000000 ...
    // 11111100 00000000 ...

    assert!(equal_subset(3, 5, &id1, &id2));
    assert!(!equal_subset(2, 5, &id1, &id2));
    assert!(!equal_subset(3, 6, &id1, &id2));
}

/// RUST_LOG=debug cargo test --package avalanche-types --lib -- ids::bits::test_equal_subset_bad_middle --exact --show-output
/// ref. "TestEqualSubsetBadMiddle"
#[test]
fn test_equal_subset_bad_middle() {
    let id1 = Id::from_slice(&vec![0x18, 0xe8, 0x55]);
    let id2 = Id::from_slice(&vec![0x18, 0x8e, 0x55]);
    // for c in &id1.0 {
    //     print!("{:08b} ", *c);
    // }
    // println!("");
    // for c in &id2.0 {
    //     print!("{:08b} ", *c);
    // }
    // big endian - most significant byte first, 0x1 == 00000001
    // 00011000 11101000 01010101 00000000 ...
    // 00011000 10001110 01010101 00000000 ...

    assert!(!equal_subset(0, 8 * 3, &id1, &id2));
}

/// RUST_LOG=debug cargo test --package avalanche-types --lib -- ids::bits::test_equal_subset_out_of_bounds --exact --show-output
/// ref. "TestEqualSubsetOutOfBounds"
#[test]
fn test_equal_subset_out_of_bounds() {
    let id1 = Id::from_slice(&vec![0x18, 0xe8, 0x55]);
    let id2 = Id::from_slice(&vec![0x18, 0x8e, 0x55]);
    assert!(!equal_subset(0, 500, &id1, &id2));
}

/// Returns the "id1" index of the first different bit in the range [start, end).
/// This does bit-per-bit comparison for the Id type of [u8; ID_LEN].
/// ref. <https://pkg.go.dev/github.com/ava-labs/avalanchego/ids#FirstDifferenceSubset>
pub fn first_difference_subset(start: usize, end: usize, id1: &Id, id2: &Id) -> (usize, bool) {
    if end == 0 {
        return (0, false);
    }

    let end = end - 1; // -1 for end index
    if start > end {
        return (0, false);
    }
    if end >= NUM_BITS {
        return (0, false);
    }

    let start_index = (start / BITS_PER_BYTES) as usize;
    let end_index = (end / BITS_PER_BYTES) as usize;

    let start_bit = (start % BITS_PER_BYTES) as usize; // index in the byte that the first bit is at
    let end_bit = (end % BITS_PER_BYTES) as usize; // index in the byte that the last bit is at

    let start_mask: i32 = -1 << start_bit; // 111...0... The number of 0s is equal to start_bit
    let end_mask: i32 = (1 << (end_bit + 1)) - 1; // 000...1... The number of 1s is equal to end_bit + 1

    if start_index == end_index {
        // if looking at same byte, both masks need to be applied
        let mask = start_mask & end_mask;

        let b1 = mask & id1.0[start_index] as i32;
        let b2 = mask & id2.0[start_index] as i32;
        if b1 == b2 {
            return (0, false);
        }

        let bd = b1 ^ b2;
        return (
            bd.trailing_zeros() as usize + start_index * BITS_PER_BYTES,
            true,
        );
    }

    let start1 = start_mask & id1.0[start_index] as i32;
    let start2 = start_mask & id2.0[start_index] as i32;
    if start1 != start2 {
        let bd = start1 ^ start2;
        return (
            bd.trailing_zeros() as usize + start_index * BITS_PER_BYTES,
            true,
        );
    }

    // check interior bits
    for idx in (start_index + 1)..end_index {
        let b1 = id1.0[idx];
        let b2 = id2.0[idx];
        if b1 != b2 {
            let bd = b1 ^ b2;
            return (bd.trailing_zeros() as usize + idx * BITS_PER_BYTES, true);
        }
    }

    let end1 = end_mask & id1.0[end_index] as i32;
    let end2 = end_mask & id2.0[end_index] as i32;
    if end1 != end2 {
        let bd = end1 ^ end2;
        return (
            bd.trailing_zeros() as usize + end_index * BITS_PER_BYTES,
            true,
        );
    }

    (0, false) // no difference found
}

/// RUST_LOG=debug cargo test --package avalanche-types --lib -- ids::bits::test_first_difference_subset --exact --show-output
#[test]
fn test_first_difference_subset() {
    // ref. TestFirstDifferenceSubsetEarlyStop
    let id1 = Id::from_slice(&vec![0xf0, 0x0f]);
    let id2 = Id::from_slice(&vec![0xf0, 0x1f]);
    // for c in &id1.0 {
    //     print!("{:08b} ", *c);
    // }
    // println!("");
    // for c in &id2.0 {
    //     print!("{:08b} ", *c);
    // }
    // big endian - most significant byte first, 0x1 == 00000001
    // 11110000 00001111 00000000 ...
    // 11110000 00011111 00000000 ...

    assert_eq!(first_difference_subset(0, 12, &id1, &id2), (0, false));
    assert_eq!(first_difference_subset(0, 13, &id1, &id2), (12, true));

    // ref. TestFirstDifferenceEqualByte4
    let id1 = Id::from_slice(&vec![0x10]);
    let id2 = Id::from_slice(&vec![0x00]);
    // for c in &id1.0 {
    //     print!("{:08b} ", *c);
    // }
    // println!("");
    // for c in &id2.0 {
    //     print!("{:08b} ", *c);
    // }
    // big endian - most significant byte first, 0x1 == 00000001
    // 00100000 00000000 ...
    // 00000000 00000000 ...

    assert_eq!(first_difference_subset(0, 4, &id1, &id2), (0, false));
    assert_eq!(first_difference_subset(0, 5, &id1, &id2), (4, true));
}

/// RUST_LOG=debug cargo test --package avalanche-types --lib -- ids::bits::test_first_difference_equal_byte_5 --exact --show-output
/// ref. TestFirstDifferenceEqualByte5
#[test]
fn test_first_difference_equal_byte_5() {
    let id1 = Id::from_slice(&vec![0x20]);
    let id2 = Id::from_slice(&vec![0x00]);
    // for c in &id1.0 {
    //     print!("{:08b} ", *c);
    // }
    // println!("");
    // for c in &id2.0 {
    //     print!("{:08b} ", *c);
    // }
    // big endian - most significant byte first, 0x1 == 00000001
    // 00100000 00000000 ...
    // 00000000 00000000 ...

    assert_eq!(first_difference_subset(0, 5, &id1, &id2), (0, false));
    assert_eq!(first_difference_subset(0, 6, &id1, &id2), (5, true));
}

/// RUST_LOG=debug cargo test --package avalanche-types --lib -- ids::bits::test_first_difference_subset_middle --exact --show-output
/// ref. TestFirstDifferenceSubsetMiddle
#[test]
fn test_first_difference_subset_middle() {
    let id1 = Id::from_slice(&vec![0xf0, 0x0f, 0x11]);
    let id2 = Id::from_slice(&vec![0xf0, 0x1f, 0xff]);
    // for c in &id1.0 {
    //     print!("{:08b} ", *c);
    // }
    // println!("");
    // for c in &id2.0 {
    //     print!("{:08b} ", *c);
    // }
    // big endian - most significant byte first, 0x1 == 00000001
    // 11110000 00001111 00010001 00000000 ...
    // 11110000 00011111 11111111 00000000 ...

    assert_eq!(first_difference_subset(0, 24, &id1, &id2), (12, true));
    assert_eq!(first_difference_subset(0, 12, &id1, &id2), (0, false));
}

/// RUST_LOG=debug cargo test --package avalanche-types --lib -- ids::bits::test_first_difference_vacuous --exact --show-output
/// ref. TestFirstDifferenceVacuous
#[test]
fn test_first_difference_vacuous() {
    let id1 = Id::from_slice(&vec![0xf0, 0x0f, 0x11]);
    let id2 = Id::from_slice(&vec![0xf0, 0x1f, 0xff]);
    // for c in &id1.0 {
    //     print!("{:08b} ", *c);
    // }
    // println!("");
    // for c in &id2.0 {
    //     print!("{:08b} ", *c);
    // }
    // big endian - most significant byte first, 0x1 == 00000001
    // 11110000 00001111 00010001 00000000 ...
    // 11110000 00011111 11111111 00000000 ...

    assert_eq!(first_difference_subset(0, 0, &id1, &id2), (0, false));
}

#[derive(
    std::clone::Clone,
    std::cmp::Eq,
    std::cmp::Ord,
    std::cmp::PartialEq,
    std::cmp::PartialOrd,
    std::fmt::Debug,
    std::hash::Hash,
)]
pub enum Bit {
    Zero,
    One,
}

impl std::convert::From<usize> for Bit {
    fn from(v: usize) -> Self {
        assert!(v <= 1);
        match v {
            0 => Bit::Zero,
            1 => Bit::One,
            _ => panic!("unexpected bit value {}", v),
        }
    }
}

impl Bit {
    /// Returns the `usize` value of the enum member.
    pub fn as_usize(&self) -> usize {
        match self {
            Bit::Zero => 0,
            Bit::One => 1,
        }
    }
}

/// Set that can contain uints in the range [0, 64).
/// All functions are O(1). The zero value is the empty set.
/// ref. <https://pkg.go.dev/github.com/ava-labs/avalanchego/ids#BitSet64>
#[derive(Debug, Clone, Copy, Eq, PartialEq)]
pub struct Set64(u64);

impl Set64 {
    pub fn new() -> Self {
        Self(0_u64)
    }

    /// Add [i] to the set of ints.
    pub fn add(&mut self, i: u64) {
        self.0 |= 1 << i;
    }

    /// Adds all the elements in [s] to this set.
    pub fn union(&mut self, s: Set64) {
        self.0 |= s.0;
    }

    /// Takes the intersection of [s] with this set.
    pub fn intersection(&mut self, s: Set64) {
        self.0 &= s.0;
    }

    /// Removes all the elements in [s] from this set.
    pub fn difference(&mut self, s: Set64) {
        // ref. *bs &^= s
        self.0 &= !(s.0);
    }

    /// Removes [i] from the set of ints with bitclear (AND NOT) operation.
    pub fn remove(&mut self, i: u64) {
        // ref. *bs &^= 1 << i
        self.0 &= !(1 << i);
    }

    /// Removes all elements from this set.
    pub fn clear(&mut self) {
        self.0 = 0;
    }

    /// Returns true if [i] was previously added to this set.
    pub fn contains(&self, i: u64) -> bool {
        (self.0 & (1 << i)) != 0
    }

    /// Returns the number of elements in the set.
    pub fn len(&self) -> u32 {
        // ref. bits.OnesCount64
        u64::count_ones(self.0)
    }

    /// Returns true if the set is empty.
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }
}

impl Default for Set64 {
    fn default() -> Self {
        Self::new()
    }
}

/// ref. <https://doc.rust-lang.org/std/string/trait.ToString.html>
/// ref. <https://doc.rust-lang.org/std/fmt/trait.Display.html>
/// Use "Self.to_string()" to directly invoke this
impl fmt::Display for Set64 {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{:#16x}", self.0)
    }
}

/// RUST_LOG=debug cargo test --package avalanche-types --lib -- ids::bits::test_bit_set --exact --show-output
#[test]
fn test_bit_set() {
    let mut bs1 = Set64::new();
    assert!(bs1.len() == 0);

    bs1.add(5);
    assert!(bs1.len() == 1);
    assert!(bs1.contains(5));

    bs1.add(10);
    assert!(bs1.len() == 2);
    assert!(bs1.contains(5));
    assert!(bs1.contains(10));

    bs1.add(10);
    assert!(bs1.len() == 2);
    assert!(bs1.contains(5));
    assert!(bs1.contains(10));

    let mut bs2 = Set64::new();
    assert!(bs2.len() == 0);

    bs2.add(0);
    assert!(bs2.len() == 1);
    assert!(bs2.contains(0));

    bs2.union(bs1);
    assert!(bs1.len() == 2);
    assert!(bs1.contains(5));
    assert!(bs1.contains(10));
    assert!(bs2.len() == 3);
    assert!(bs2.contains(0));
    assert!(bs2.contains(5));
    assert!(bs2.contains(10));

    bs1.clear();
    assert!(bs1.len() == 0);
    assert!(bs2.len() == 3);
    assert!(bs2.contains(0));
    assert!(bs2.contains(5));
    assert!(bs2.contains(10));

    bs1.add(63);
    assert!(bs1.len() == 1);
    assert!(bs1.contains(63));

    bs1.add(1);
    assert!(bs1.len() == 2);
    assert!(bs1.contains(1));
    assert!(bs1.contains(63));

    bs1.remove(63);
    assert!(bs1.len() == 1);
    assert!(bs1.contains(1));

    let mut bs3 = Set64::new();
    bs3.add(0);
    bs3.add(2);
    bs3.add(5);

    let mut bs4 = Set64::new();
    bs4.add(2);
    bs4.add(5);

    bs3.intersection(bs4);

    assert!(bs3.len() == 2);
    assert!(bs3.contains(2));
    assert!(bs3.contains(5));
    assert!(bs4.len() == 2);
    assert!(bs4.contains(2));
    assert!(bs4.contains(5));

    let mut bs5 = Set64::new();
    bs5.add(7);
    bs5.add(11);
    bs5.add(9);

    let mut bs6 = Set64::new();
    bs6.add(9);
    bs6.add(11);

    bs5.difference(bs6);

    assert!(bs5.len() == 1);
    assert!(bs5.contains(7));
    assert!(bs6.len() == 2);
    assert!(bs6.contains(9));
    assert!(bs6.contains(11));
}