|
| 1 | +use crate::{ContainerKey, RoaringBitmap, Value, ValueRange}; |
| 2 | +use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt}; |
| 3 | +use std::{ |
| 4 | + io, |
| 5 | + ops::{Bound, RangeBounds, RangeInclusive}, |
| 6 | +}; |
| 7 | + |
| 8 | +/// A compressed bitmap for 64-bit values. |
| 9 | +/// |
| 10 | +/// # Examples |
| 11 | +/// |
| 12 | +/// ```rust |
| 13 | +/// use roaring::Roaring64; |
| 14 | +/// |
| 15 | +/// let mut rb = Roaring64::new(); |
| 16 | +/// |
| 17 | +/// // insert all primes less than 10 |
| 18 | +/// rb.insert(2); |
| 19 | +/// rb.insert(3); |
| 20 | +/// rb.insert(5); |
| 21 | +/// rb.insert(7); |
| 22 | +/// println!("total bits set to true: {}", rb.len()); |
| 23 | +/// ``` |
| 24 | +pub type Roaring64 = RoaringBitmap<u64>; |
| 25 | + |
| 26 | +impl Value for u64 { |
| 27 | + type Key = u64; |
| 28 | + type Range = RangeInclusive<Self>; |
| 29 | + |
| 30 | + fn split(self) -> (Self::Key, u16) { |
| 31 | + (self >> 16, self as u16) |
| 32 | + } |
| 33 | + |
| 34 | + fn join(key: Self::Key, index: u16) -> Self { |
| 35 | + (key << 16) + u64::from(index) |
| 36 | + } |
| 37 | + |
| 38 | + fn range(range: impl RangeBounds<Self>) -> Option<Self::Range> { |
| 39 | + let start: u64 = match range.start_bound() { |
| 40 | + Bound::Included(&i) => i, |
| 41 | + Bound::Excluded(&i) => i.checked_add(1)?, |
| 42 | + Bound::Unbounded => 0, |
| 43 | + }; |
| 44 | + let end: u64 = match range.end_bound() { |
| 45 | + Bound::Included(&i) => i, |
| 46 | + Bound::Excluded(&i) => i.checked_sub(1)?, |
| 47 | + Bound::Unbounded => u64::MAX, |
| 48 | + }; |
| 49 | + |
| 50 | + if end < start { |
| 51 | + return None; |
| 52 | + } |
| 53 | + |
| 54 | + Some(start..=end) |
| 55 | + } |
| 56 | + |
| 57 | + fn max_containers() -> usize { |
| 58 | + // Theoretically, u64::MAX + 1. |
| 59 | + // Realistically we're probably capped at usize anyway. |
| 60 | + usize::MAX |
| 61 | + } |
| 62 | +} |
| 63 | + |
| 64 | +impl ContainerKey for u64 { |
| 65 | + #[inline(always)] |
| 66 | + fn size() -> usize { |
| 67 | + // Key is coded on 48-bit, the 16 upper ones are unused. |
| 68 | + 6 |
| 69 | + } |
| 70 | + |
| 71 | + fn write(self, writer: &mut impl WriteBytesExt) -> io::Result<()> { |
| 72 | + writer.write_u48::<LittleEndian>(self) |
| 73 | + } |
| 74 | + |
| 75 | + fn read(reader: &mut impl ReadBytesExt) -> io::Result<Self> { |
| 76 | + reader.read_u48::<LittleEndian>() |
| 77 | + } |
| 78 | +} |
| 79 | + |
| 80 | +impl ValueRange<u64> for RangeInclusive<u64> { |
| 81 | + type KeyIterator = RangeInclusive<u64>; |
| 82 | + |
| 83 | + fn start(&self) -> (<u64 as Value>::Key, u16) { |
| 84 | + self.start().split() |
| 85 | + } |
| 86 | + |
| 87 | + fn end(&self) -> (<u64 as Value>::Key, u16) { |
| 88 | + self.end().split() |
| 89 | + } |
| 90 | + |
| 91 | + fn containers_count(&self) -> usize { |
| 92 | + let start = ValueRange::start(self).0; |
| 93 | + let end = ValueRange::end(self).0; |
| 94 | + (end - start) as usize + 1 |
| 95 | + } |
| 96 | + |
| 97 | + fn keys(self) -> Self::KeyIterator { |
| 98 | + let start = ValueRange::start(&self).0; |
| 99 | + let end = ValueRange::end(&self).0; |
| 100 | + start..=end |
| 101 | + } |
| 102 | +} |
| 103 | + |
| 104 | +#[cfg(test)] |
| 105 | +mod test { |
| 106 | + use super::*; |
| 107 | + |
| 108 | + #[test] |
| 109 | + fn split() { |
| 110 | + assert_eq!((0x0000_0000_0000u64, 0x0000u16), 0x0000_0000_0000_0000u64.split()); |
| 111 | + assert_eq!((0x0000_0000_0000u64, 0x0001u16), 0x0000_0000_0000_0001u64.split()); |
| 112 | + assert_eq!((0x0000_0000_FFFFu64, 0xFFFEu16), 0x0000_0000_FFFF_FFFEu64.split()); |
| 113 | + assert_eq!((0x0000_0000_FFFFu64, 0xFFFFu16), 0x0000_0000_FFFF_FFFFu64.split()); |
| 114 | + assert_eq!((0x0000_0001_0000u64, 0x0000u16), 0x0000_0001_0000_0000u64.split()); |
| 115 | + assert_eq!((0x0000_0001_0000u64, 0x0001u16), 0x0000_0001_0000_0001u64.split()); |
| 116 | + assert_eq!((0xFFFF_FFFF_FFFFu64, 0xFFFEu16), 0xFFFF_FFFF_FFFF_FFFEu64.split()); |
| 117 | + assert_eq!((0xFFFF_FFFF_FFFFu64, 0xFFFFu16), 0xFFFF_FFFF_FFFF_FFFFu64.split()); |
| 118 | + } |
| 119 | + |
| 120 | + #[test] |
| 121 | + fn join() { |
| 122 | + assert_eq!(0x0000_0000_0000_0000u64, u64::join(0x0000_0000_0000u64, 0x0000u16)); |
| 123 | + assert_eq!(0x0000_0000_0000_0001u64, u64::join(0x0000_0000_0000u64, 0x0001u16)); |
| 124 | + assert_eq!(0x0000_0000_FFFF_FFFEu64, u64::join(0x0000_0000_FFFFu64, 0xFFFEu16)); |
| 125 | + assert_eq!(0x0000_0000_FFFF_FFFFu64, u64::join(0x0000_0000_FFFFu64, 0xFFFFu16)); |
| 126 | + assert_eq!(0x0000_0001_0000_0000u64, u64::join(0x0000_0001_0000u64, 0x0000u16)); |
| 127 | + assert_eq!(0x0000_0001_0000_0001u64, u64::join(0x0000_0001_0000u64, 0x0001u16)); |
| 128 | + assert_eq!(0xFFFF_FFFF_FFFF_FFFEu64, u64::join(0xFFFF_FFFF_FFFFu64, 0xFFFEu16)); |
| 129 | + assert_eq!(0xFFFF_FFFF_FFFF_FFFFu64, u64::join(0xFFFF_FFFF_FFFFu64, 0xFFFFu16)); |
| 130 | + } |
| 131 | + |
| 132 | + #[test] |
| 133 | + fn range() { |
| 134 | + assert_eq!(Some(1..=5), u64::range(1..6)); |
| 135 | + assert_eq!(Some(1..=u64::MAX), u64::range(1..)); |
| 136 | + assert_eq!(Some(0..=u64::MAX), u64::range(..)); |
| 137 | + assert_eq!(None, u64::range(5..5)); |
| 138 | + assert_eq!(Some(16..=16), u64::range(16..=16)) |
| 139 | + } |
| 140 | +} |
0 commit comments