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
use std::collections::btree_map::{BTreeMap, Entry};
use std::iter;
use std::ops::RangeBounds;
use crate::RoaringBitmap;
use crate::RoaringTreemap;
use super::util;
impl RoaringTreemap {
/// Creates an empty `RoaringTreemap`.
///
/// # Examples
///
/// ```rust
/// use roaring::RoaringTreemap;
/// let rb = RoaringTreemap::new();
/// ```
pub fn new() -> RoaringTreemap {
RoaringTreemap { map: BTreeMap::new() }
}
/// Creates a full `RoaringTreemap`.
///
/// # Examples
///
/// ```rust,ignore
/// use roaring::RoaringTreemap;
/// let rb = RoaringTreemap::full();
/// ```
pub fn full() -> RoaringTreemap {
RoaringTreemap { map: (0..=u32::MAX).zip(iter::repeat(RoaringBitmap::full())).collect() }
}
/// Adds a value to the set. Returns `true` if the value was not already present in the set.
///
/// # Examples
///
/// ```rust
/// use roaring::RoaringTreemap;
///
/// let mut rb = RoaringTreemap::new();
/// assert_eq!(rb.insert(3), true);
/// assert_eq!(rb.insert(3), false);
/// assert_eq!(rb.contains(3), true);
/// ```
pub fn insert(&mut self, value: u64) -> bool {
let (hi, lo) = util::split(value);
self.map.entry(hi).or_insert_with(RoaringBitmap::new).insert(lo)
}
/// Inserts a range of values.
///
/// Returns the number of inserted values.
///
/// # Examples
///
/// ```rust
/// use roaring::RoaringTreemap;
///
/// let mut rb = RoaringTreemap::new();
/// rb.insert_range(2..4);
/// assert!(rb.contains(2));
/// assert!(rb.contains(3));
/// assert!(!rb.contains(4));
/// ```
pub fn insert_range<R: RangeBounds<u64>>(&mut self, range: R) -> u64 {
let (start, end) = match util::convert_range_to_inclusive(range) {
Some(range) => (*range.start(), *range.end()),
None => return 0,
};
let (start_hi, start_lo) = util::split(start);
let (end_hi, end_lo) = util::split(end);
let mut counter = 0u64;
// Split the input range by the leading 32 bits
for hi in start_hi..=end_hi {
let entry = self.map.entry(hi);
// Calculate the sub-range from the lower 32 bits
counter += if hi == end_hi && hi == start_hi {
entry.or_insert_with(RoaringBitmap::new).insert_range(start_lo..=end_lo)
} else if hi == start_hi {
entry.or_insert_with(RoaringBitmap::new).insert_range(start_lo..=u32::MAX)
} else if hi == end_hi {
entry.or_insert_with(RoaringBitmap::new).insert_range(0..=end_lo)
} else {
// We insert a full bitmap if it doesn't already exist and return the size of it.
// But if the bitmap already exists at this spot we replace it with a full bitmap
// and specify that we didn't inserted the integers from the previous bitmap.
let full_bitmap = RoaringBitmap::full();
match entry {
Entry::Vacant(entry) => entry.insert(full_bitmap).len(),
Entry::Occupied(mut entry) => {
full_bitmap.len() - entry.insert(full_bitmap).len()
}
}
};
}
counter
}
/// Pushes `value` in the treemap only if it is greater than the current maximum value.
///
/// Returns whether the value was inserted.
///
/// # Examples
///
/// ```rust
/// use roaring::RoaringTreemap;
///
/// let mut rb = RoaringTreemap::new();
/// assert!(rb.push(1));
/// assert!(rb.push(3));
/// assert_eq!(rb.push(3), false);
/// assert!(rb.push(5));
///
/// assert_eq!(rb.iter().collect::<Vec<u64>>(), vec![1, 3, 5]);
/// ```
pub fn push(&mut self, value: u64) -> bool {
let (hi, lo) = util::split(value);
self.map.entry(hi).or_insert_with(RoaringBitmap::new).push(lo)
}
/// Pushes `value` in the treemap only if it is greater than the current maximum value.
/// It is up to the caller to have validated index > self.max()
///
/// # Panics
///
/// If debug_assertions enabled and index is > self.max()
pub(crate) fn push_unchecked(&mut self, value: u64) {
let (hi, lo) = util::split(value);
// BTreeMap last_mut not stabilized see https://github.com/rust-lang/rust/issues/62924
match self.map.iter_mut().next_back() {
Some((&key, bitmap)) if key == hi => bitmap.push_unchecked(lo),
Some((&key, _)) if cfg!(debug_assertions) && key > hi => {
panic!("last bitmap key > key of value")
}
_otherwise => {
// The tree is empty
let mut rb = RoaringBitmap::new();
rb.push_unchecked(lo);
self.map.insert(hi, rb);
}
}
}
/// Removes a value from the set. Returns `true` if the value was present in the set.
///
/// # Examples
///
/// ```rust
/// use roaring::RoaringTreemap;
///
/// let mut rb = RoaringTreemap::new();
/// rb.insert(3);
/// assert_eq!(rb.remove(3), true);
/// assert_eq!(rb.remove(3), false);
/// assert_eq!(rb.contains(3), false);
/// ```
pub fn remove(&mut self, value: u64) -> bool {
let (hi, lo) = util::split(value);
match self.map.entry(hi) {
Entry::Vacant(_) => false,
Entry::Occupied(mut ent) => {
if ent.get_mut().remove(lo) {
if ent.get().is_empty() {
ent.remove();
}
true
} else {
false
}
}
}
}
/// Removes a range of values.
/// Returns the number of removed values.
///
/// # Examples
///
/// ```rust
/// use roaring::RoaringTreemap;
///
/// let mut rb = RoaringTreemap::new();
/// rb.insert(2);
/// rb.insert(3);
/// assert_eq!(rb.remove_range(2..4), 2);
/// ```
pub fn remove_range<R>(&mut self, range: R) -> u64
where
R: RangeBounds<u64>,
{
let (start, end) = match util::convert_range_to_inclusive(range) {
Some(range) => (*range.start(), *range.end()),
None => return 0,
};
let (start_container_key, start_index) = util::split(start);
let (end_container_key, end_index) = util::split(end);
let mut keys_to_remove = Vec::new();
let mut removed = 0;
for (&key, rb) in &mut self.map {
if key >= start_container_key && key <= end_container_key {
let a = if key == start_container_key { start_index } else { 0 };
let b = if key == end_container_key { end_index } else { u32::MAX };
removed += rb.remove_range(a..=b);
if rb.is_empty() {
keys_to_remove.push(key);
}
}
}
for key in keys_to_remove {
self.map.remove(&key);
}
removed
}
/// Returns `true` if this set contains the specified integer.
///
/// # Examples
///
/// ```rust
/// use roaring::RoaringTreemap;
///
/// let mut rb = RoaringTreemap::new();
/// rb.insert(1);
/// assert_eq!(rb.contains(0), false);
/// assert_eq!(rb.contains(1), true);
/// assert_eq!(rb.contains(100), false);
/// ```
pub fn contains(&self, value: u64) -> bool {
let (hi, lo) = util::split(value);
match self.map.get(&hi) {
None => false,
Some(r) => r.contains(lo),
}
}
/// Clears all integers in this set.
///
/// # Examples
///
/// ```rust
/// use roaring::RoaringTreemap;
///
/// let mut rb = RoaringTreemap::new();
/// rb.insert(1);
/// assert_eq!(rb.contains(1), true);
/// rb.clear();
/// assert_eq!(rb.contains(1), false);
/// ```
pub fn clear(&mut self) {
self.map.clear();
}
/// Returns `true` if there are no integers in this set.
///
/// # Examples
///
/// ```rust
/// use roaring::RoaringTreemap;
///
/// let mut rb = RoaringTreemap::new();
/// assert_eq!(rb.is_empty(), true);
///
/// rb.insert(3);
/// assert_eq!(rb.is_empty(), false);
/// ```
pub fn is_empty(&self) -> bool {
self.map.values().all(RoaringBitmap::is_empty)
}
/// Returns `true` if there are every possible integers in this set.
///
/// # Examples
///
/// ```rust,ignore
/// use roaring::RoaringTreemap;
///
/// let mut rb = RoaringTreemap::full();
/// assert!(!rb.is_empty());
/// assert!(rb.is_full());
/// ```
pub fn is_full(&self) -> bool {
self.map.len() == (u32::MAX as usize + 1) && self.map.values().all(RoaringBitmap::is_full)
}
/// Returns the number of distinct integers added to the set.
///
/// # Examples
///
/// ```rust
/// use roaring::RoaringTreemap;
///
/// let mut rb = RoaringTreemap::new();
/// assert_eq!(rb.len(), 0);
///
/// rb.insert(3);
/// assert_eq!(rb.len(), 1);
///
/// rb.insert(3);
/// rb.insert(4);
/// assert_eq!(rb.len(), 2);
/// ```
pub fn len(&self) -> u64 {
self.map.values().map(RoaringBitmap::len).sum()
}
/// Returns the minimum value in the set (if the set is non-empty).
///
/// # Examples
///
/// ```rust
/// use roaring::RoaringTreemap;
///
/// let mut rb = RoaringTreemap::new();
/// assert_eq!(rb.min(), None);
///
/// rb.insert(3);
/// rb.insert(4);
/// assert_eq!(rb.min(), Some(3));
/// ```
pub fn min(&self) -> Option<u64> {
self.map
.iter()
.find(|&(_, rb)| rb.min().is_some())
.map(|(k, rb)| util::join(*k, rb.min().unwrap()))
}
/// Returns the maximum value in the set (if the set is non-empty).
///
/// # Examples
///
/// ```rust
/// use roaring::RoaringTreemap;
///
/// let mut rb = RoaringTreemap::new();
/// assert_eq!(rb.max(), None);
///
/// rb.insert(3);
/// rb.insert(4);
/// assert_eq!(rb.max(), Some(4));
/// ```
pub fn max(&self) -> Option<u64> {
self.map
.iter()
.rev()
.find(|&(_, rb)| rb.max().is_some())
.map(|(k, rb)| util::join(*k, rb.max().unwrap()))
}
/// Returns the number of integers that are <= value. rank(u64::MAX) == len()
///
/// # Examples
///
/// ```rust
/// use roaring::RoaringTreemap;
///
/// let mut rb = RoaringTreemap::new();
/// assert_eq!(rb.rank(0), 0);
///
/// rb.insert(3);
/// rb.insert(4);
/// assert_eq!(rb.rank(3), 1);
/// assert_eq!(rb.rank(10), 2)
/// ```
pub fn rank(&self, value: u64) -> u64 {
// if len becomes cached for RoaringTreemap: return len if len > value
let (hi, lo) = util::split(value);
let mut iter = self.map.range(..=hi).rev();
iter.next()
.map(|(&k, bitmap)| if k == hi { bitmap.rank(lo) } else { bitmap.len() })
.unwrap_or(0)
+ iter.map(|(_, bitmap)| bitmap.len()).sum::<u64>()
}
/// Returns the `n`th integer in the set or `None` if `n <= len()`
///
/// # Examples
///
/// ```rust
/// use roaring::RoaringTreemap;
///
/// let mut rb = RoaringTreemap::new();
/// assert_eq!(rb.select(0), None);
///
/// rb.append(vec![0, 10, 100]);
///
/// assert_eq!(rb.select(0), Some(0));
/// assert_eq!(rb.select(1), Some(10));
/// assert_eq!(rb.select(2), Some(100));
/// assert_eq!(rb.select(3), None);
/// ```
pub fn select(&self, mut n: u64) -> Option<u64> {
for (&key, bitmap) in &self.map {
let len = bitmap.len();
if len > n {
return Some((key as u64) << 32 | bitmap.select(n as u32).unwrap() as u64);
}
n -= len;
}
None
}
}
impl Default for RoaringTreemap {
fn default() -> RoaringTreemap {
RoaringTreemap::new()
}
}
impl Clone for RoaringTreemap {
fn clone(&self) -> Self {
RoaringTreemap { map: self.map.clone() }
}
fn clone_from(&mut self, other: &Self) {
self.map.clone_from(&other.map);
}
}