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
//! This module contains an implementation of an above-extra-range set. //! //! # Examples //! ``` //! use threshold::*; //! //! let mut above_range_set = AboveRangeSet::new(); //! assert_eq!(above_range_set.next_event(), 1); //! assert!(above_range_set.is_event(1)); //! assert!(!above_range_set.is_event(2)); //! //! let other = AboveRangeSet::from_event(3); //! assert!(!other.is_event(1)); //! assert!(!other.is_event(2)); //! assert!(other.is_event(3)); //! //! above_range_set.join(&other); //! assert!(above_range_set.is_event(1)); //! assert!(!above_range_set.is_event(2)); //! assert!(above_range_set.is_event(3)); //! ``` use crate::EventSet; use serde::{Deserialize, Serialize}; use std::cmp; use std::cmp::Ordering; use std::collections::btree_map::{self, BTreeMap}; use std::collections::HashMap; use std::fmt; use std::iter::FromIterator; #[derive(Clone, PartialEq, Eq, Default, Serialize, Deserialize)] pub struct AboveRangeSet { // Highest contiguous event seen max: u64, // Set of extra events encoded as ranges ranges: Ranges, } #[derive(Clone, PartialEq, Eq, Default, Serialize, Deserialize)] pub struct Ranges { // Mapping from start of the range to its end (sorted ASC) ranges: HashMap<u64, u64>, } impl EventSet for AboveRangeSet { type EventIter = EventIter; /// Returns a new `AboveRangeSet` instance. fn new() -> Self { AboveRangeSet { max: 0, ranges: Ranges::new(), } } /// Generates the next event. /// There should be no extra ranges when calling this. /// /// # Examples /// ``` /// use threshold::*; /// /// let mut above_range_set = AboveRangeSet::new(); /// assert_eq!(above_range_set.next_event(), 1); /// assert_eq!(above_range_set.next_event(), 2); /// ``` fn next_event(&mut self) -> u64 { debug_assert!(self.ranges.is_empty()); self.max += 1; self.max } /// Adds an event to the set. /// Returns `true` if it's a new event. /// /// # Examples /// ``` /// use threshold::*; /// /// let mut above_range_set = AboveRangeSet::new(); /// /// above_range_set.add_event(1); /// assert!(above_range_set.is_event(1)); /// assert!(!above_range_set.is_event(2)); /// /// above_range_set.add_event(3); /// assert!(above_range_set.is_event(1)); /// assert!(!above_range_set.is_event(2)); /// assert!(above_range_set.is_event(3)); /// /// above_range_set.add_event(2); /// assert!(above_range_set.is_event(1)); /// assert!(above_range_set.is_event(2)); /// assert!(above_range_set.is_event(3)); /// ``` fn add_event(&mut self, event: u64) -> bool { let next_max = self.max + 1; match event.cmp(&next_max) { Ordering::Equal => { // this event is now the new max self.max = event; // maybe compress self.try_compress(); // new event, so `true` true } Ordering::Greater => { // add as a range: assumes it's a new range self.ranges.add(event, event); true } Ordering::Less => { // else it's already an event false } } } /// Adds a range of events to the set. fn add_event_range(&mut self, start: u64, end: u64) -> bool { if start <= self.max + 1 && end > self.max { // the end of the range is now the new max self.max = end; // maybe compress self.try_compress(); // new event, so `true` true } else if start > self.max + 1 { // add as a range: assumes it's a new range self.ranges.add(start, end); true } else { // else all events are already an event false } } /// Checks if an event is part of the set. /// /// # Examples /// ``` /// use threshold::*; /// /// let mut above_range_set = AboveRangeSet::new(); /// let event = above_range_set.next_event(); /// assert!(above_range_set.is_event(event)); /// /// above_range_set.add_event(3); /// assert!(!above_range_set.is_event(2)); /// assert!(above_range_set.is_event(3)); /// ``` fn is_event(&self, event: u64) -> bool { event <= self.max || self.ranges.contains(&event) } /// Returns all events seen as a tuple. /// The first component is the highest event seen, while the second is a /// vector with the exceptions (in no specific order). /// /// # Examples /// ``` /// use threshold::*; /// /// let mut above_range_set = AboveRangeSet::new(); /// /// above_range_set.add_event(1); /// assert_eq!(above_range_set.events(), (1, vec![])); /// /// above_range_set.add_event(3); /// assert_eq!(above_range_set.events(), (1, vec![3])); /// /// above_range_set.add_event(2); /// assert_eq!(above_range_set.events(), (3, vec![])); /// /// above_range_set.add_event(4); /// assert_eq!(above_range_set.events(), (4, vec![])); /// /// above_range_set.add_event(6); /// assert_eq!(above_range_set.events(), (4, vec![6])); /// ``` fn events(&self) -> (u64, Vec<u64>) { (self.max, self.ranges.clone().event_iter().collect()) } /// Returns the frontier (the highest contiguous event seen). /// /// # Examples /// ``` /// use threshold::*; /// /// let mut above_range_set = AboveRangeSet::new(); /// assert_eq!(above_range_set.frontier(), 0); /// /// above_range_set.add_event(1); /// assert_eq!(above_range_set.frontier(), 1); /// /// above_range_set.add_event(3); /// assert_eq!(above_range_set.frontier(), 1); /// /// above_range_set.add_event(2); /// assert_eq!(above_range_set.frontier(), 3); /// /// above_range_set.add_event(4); /// assert_eq!(above_range_set.frontier(), 4); /// /// above_range_set.add_event(6); /// assert_eq!(above_range_set.frontier(), 4); /// ``` fn frontier(&self) -> u64 { self.max } /// Merges `other` `AboveRangeSet` into `self`. /// /// # Examples /// ``` /// use threshold::*; /// /// let mut above_range_set = AboveRangeSet::new(); /// above_range_set.add_event(1); /// above_range_set.add_event(3); /// above_range_set.add_event(4); /// assert_eq!(above_range_set.events(), (1, vec![3, 4])); /// /// above_range_set.join(&AboveRangeSet::from_event(3)); /// assert_eq!(above_range_set.events(), (1, vec![3, 4])); /// /// above_range_set.join(&AboveRangeSet::from_event(5)); /// assert_eq!(above_range_set.events(), (1, vec![3, 4, 5])); /// /// let mut other = AboveRangeSet::new(); /// other.add_event(2); /// other.add_event(7); /// above_range_set.join(&other); /// assert_eq!(above_range_set.events(), (5, vec![7])); /// ``` fn join(&mut self, other: &Self) { // the new max value is the max of both max values self.max = cmp::max(self.max, other.max); // join ranges self.ranges.join(&other.ranges, self.max); // maybe compress self.try_compress(); } fn meet(&mut self, _other: &Self) { todo!("AboveRangeSet::meet not yet implemented") } /// Returns a `AboveRangeSet` event iterator with all events from lowest to /// highest. /// /// # Examples /// ``` /// use threshold::*; /// /// let mut above_range_set = AboveRangeSet::new(); /// above_range_set.add_event(3); /// above_range_set.add_event(5); /// /// let mut iter = above_range_set.event_iter(); /// assert_eq!(iter.next(), Some(3)); /// assert_eq!(iter.next(), Some(5)); /// assert_eq!(iter.next(), None); /// ``` fn event_iter(self) -> Self::EventIter { EventIter { current: 0, max: self.max, ranges: self.ranges.event_iter(), } } } impl AboveRangeSet { /// Tries to set a new max contiguous event. fn try_compress(&mut self) { // drop the first range while its start is right after the max while let Some(new_max) = self.ranges.try_drop(self.max + 1) { self.max = new_max; } } /// Creates a new instance from the highest contiguous event, and a sequence /// of extra events. /// /// # Examples /// ``` /// use threshold::*; /// /// let above_range_set = AboveRangeSet::from(0, vec![2, 4, 5]); /// assert!(!above_range_set.is_event(1)); /// assert!(above_range_set.is_event(2)); /// assert!(!above_range_set.is_event(3)); /// assert!(above_range_set.is_event(4)); /// assert!(above_range_set.is_event(5)); /// assert!(!above_range_set.is_event(6)); /// ``` pub fn from<I: IntoIterator<Item = u64>>(max: u64, iter: I) -> Self { let ranges = Ranges::from::<I>(iter); AboveRangeSet { max, ranges } } } pub struct EventIter { // Last contiguous value returned by the iterator current: u64, // Last contiguous value that should be returned by the iterator max: u64, // Iterator of extra ranges ranges: RangesIter, } impl Iterator for EventIter { type Item = u64; fn next(&mut self) -> Option<Self::Item> { if self.current == self.max { // we've reached the last contiguous, just call next on the extra // ranges iterator self.ranges.next() } else { // compute next value self.current += 1; Some(self.current) } } } impl fmt::Debug for AboveRangeSet { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { if self.ranges.is_empty() { write!(f, "{}", self.max) } else { write!(f, "({} + {:?})", self.max, self.ranges) } } } impl Ranges { /// Creates a new `Ranges` instance. fn new() -> Self { Ranges { ranges: HashMap::new(), } } /// Checks if there are no ranges. fn is_empty(&self) -> bool { self.ranges.is_empty() } /// Adds a new range, assuming it is new, i.e.: /// - none of the events within the range have already been added. fn add(&mut self, start: u64, end: u64) { self.ranges.insert(start, end); } /// Adds a new range, assuming it is new, i.e.: /// - none of the events within the range have already been added. /// TODO it didn't look worth compressing so we moved from BTreeMap to /// HashMap // fn add_and_compress(&mut self, start: u64, mut end: u64) { // // split map where the new range should be inserted // let mut after_new_range = self.ranges.split_off(&start); // let mut inserted = false; // // check if the previous range can be extended with the new range // if let Some(mut before) = self.ranges.last_entry() { // let before_end = before.get_mut(); // if *before_end + 1 == start { // // extend the previous range // *before_end = end; // // check if we can also extend this range with the first // range // in the splitted off ranges // if let Some(after) = after_new_range.first_entry() { // if *before_end + 1 == *after.key() { // // remove entry and extend range again // *before_end = after.remove(); // } // } // // we're done, we only need to merge the splitted off ranges // inserted = true; // } // } // // if here haven't extended the previous range, then we need to // create a // new one // if !inserted { // // check if we should create a new one with the provided `end`, // or // with the end of the next range (in case they can be // merged) if let Some(after) = after_new_range.first_entry() { // if end + 1 == *after.key() { // // remove entry and extend new range to be added // end = after.remove(); // } // } // // insert new range // self.ranges.insert(start, end); // } // // extend map with the ranges that have been splitted off // self.ranges.append(&mut after_new_range); // } /// Checks if the event is part of any of the ranges. This implementation /// makes no effort in being efficient. fn contains(&self, event: &u64) -> bool { self.ranges .iter() .any(|(start, end)| start <= event && event <= end) } /// Joins two ranges. This implementation makes no effort in being /// efficient. fn join(&mut self, other: &Self, max: u64) { let mut result = Ranges::new(); // add all events from self that are higher than the new max for event in self.clone().event_iter() { if event > max { result.add(event, event); } } // add all events from `other` that are higher than the new max // AND haven't been added yet for event in other.clone().event_iter() { if event > max && !result.contains(&event) { result.add(event, event); } } self.ranges = result.ranges; } /// Creates a iterator for all events represented by the ranges. This /// implementation makes no effort in being efficient. fn event_iter(self) -> RangesIter { RangesIter { current: None, ranges: BTreeMap::from_iter(self.ranges).into_iter(), } } /// Creates a new `Ranges` from a set of events. /// Assumes there are no repeated events. fn from<I: IntoIterator<Item = u64>>(iter: I) -> Self { let mut result = Ranges::new(); for event in iter { result.add(event, event); } result } /// Try to drop the range. If it succeeds then it can be used to update the /// maximum value. fn try_drop(&mut self, next: u64) -> Option<u64> { self.ranges.remove(&next) } } pub struct RangesIter { current: Option<(u64, u64)>, ranges: btree_map::IntoIter<u64, u64>, } impl Iterator for RangesIter { type Item = u64; fn next(&mut self) -> Option<Self::Item> { // if currently iterating a range, then keep going if let Some((val, end)) = self.current { if val <= end { self.current = Some((val + 1, end)); return Some(val); } } // if we haven't returned a new value from the current range, try again // in the next range self.current = self.ranges.next(); if self.current.is_none() { // if there's no next range, we're done None } else { self.next() } } } impl fmt::Debug for Ranges { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!(f, "{:?}", self.ranges) } }