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
//! This module contains an implementation of a max set. //! //! # Examples //! ``` //! use threshold::*; //! //! let mut maxset = MaxSet::new(); //! assert_eq!(maxset.next_event(), 1); //! assert!(maxset.is_event(1)); //! assert!(!maxset.is_event(2)); //! //! let other = MaxSet::from_event(3); //! assert!(other.is_event(1)); //! assert!(other.is_event(2)); //! assert!(other.is_event(3)); //! //! maxset.join(&other); //! assert!(maxset.is_event(3)); //! ``` use crate::EventSet; use serde::{Deserialize, Serialize}; use std::fmt; #[derive(Clone, PartialEq, Eq, Default, Serialize, Deserialize)] pub struct MaxSet { // Highest event seen max: u64, } impl EventSet for MaxSet { type EventIter = EventIter; /// Returns a new `MaxSet` instance. fn new() -> Self { MaxSet { max: 0 } } /// Generates the next event. /// /// # Examples /// ``` /// use threshold::*; /// /// let mut maxset = MaxSet::new(); /// assert_eq!(maxset.next_event(), 1); /// assert_eq!(maxset.next_event(), 2); /// ``` fn next_event(&mut self) -> u64 { self.max += 1; self.max } /// Adds an event to the set. /// Returns `true` if it's a new event. /// /// # Examples /// ``` /// use threshold::*; /// /// let mut maxset = MaxSet::new(); /// assert!(!maxset.is_event(9)); /// assert!(!maxset.is_event(10)); /// /// maxset.add_event(10); /// assert!(maxset.is_event(9)); /// assert!(maxset.is_event(10)); /// ``` fn add_event(&mut self, event: u64) -> bool { if event <= self.max { false } else { self.max = event; true } } /// Adds a range of events to the set. /// Returns `true` if a new event was added. /// /// In the case of `MaxSet` we have that: /// - `add_event_range(start, end) == add_event(end)` fn add_event_range(&mut self, start: u64, end: u64) -> bool { debug_assert!(start <= end); self.add_event(end) } /// Checks if an event is part of the set. /// /// # Examples /// ``` /// use threshold::*; /// /// let mut maxset = MaxSet::new(); /// let event = maxset.next_event(); /// assert!(maxset.is_event(event)); /// ``` fn is_event(&self, event: u64) -> bool { event <= self.max } /// Returns all events seen. /// /// # Examples /// ``` /// use threshold::*; /// /// let mut maxset = MaxSet::new(); /// maxset.add_event(2); /// maxset.add_event(4); /// assert_eq!(maxset.events(), (4, vec![])); /// ``` fn events(&self) -> (u64, Vec<u64>) { (self.max, vec![]) } /// Returns the frontier (the highest contiguous event seen). /// For a `MaxSet`, this is not necessarily the highest contiguous event, /// but simply the highest event. /// For exact `EventSet` representations that will actually return the /// highest contiguous event, see `AboveExSet` and `BelowExSet`. /// /// # Examples /// ``` /// use threshold::*; /// /// let mut maxset = MaxSet::new(); /// assert_eq!(maxset.frontier(), 0); /// /// maxset.add_event(1); /// assert_eq!(maxset.frontier(), 1); /// /// maxset.add_event(3); /// assert_eq!(maxset.frontier(), 3); /// /// maxset.add_event(2); /// assert_eq!(maxset.frontier(), 3); /// /// maxset.add_event(4); /// assert_eq!(maxset.frontier(), 4); /// /// maxset.add_event(6); /// assert_eq!(maxset.frontier(), 6); /// ``` fn frontier(&self) -> u64 { self.max } /// Merges `other` `MaxSet` into `self`. /// /// # Examples /// ``` /// use threshold::*; /// /// let mut maxset = MaxSet::from_event(10); /// assert!(!maxset.is_event(20)); /// /// maxset.join(&MaxSet::from_event(20)); /// assert!(maxset.is_event(20)); /// ``` fn join(&mut self, other: &Self) { self.max = std::cmp::max(self.max, other.max); } /// Intersects `other` `MaxSet` with `self`. /// /// # Examples /// ``` /// use threshold::*; /// /// let mut maxset = MaxSet::from_event(20); /// assert!(maxset.is_event(20)); /// /// maxset.meet(&MaxSet::from_event(10)); /// assert!(!maxset.is_event(20)); /// ``` fn meet(&mut self, other: &Self) { self.max = std::cmp::min(self.max, other.max); } /// Returns a `MaxSet` event iterator with all events from lowest to /// highest. /// /// # Examples /// ``` /// use threshold::*; /// /// let mut maxset = MaxSet::new(); /// maxset.add_event(3); /// /// let mut iter = maxset.event_iter(); /// assert_eq!(iter.next(), Some(1)); /// assert_eq!(iter.next(), Some(2)); /// assert_eq!(iter.next(), Some(3)); /// assert_eq!(iter.next(), None); /// ``` fn event_iter(self) -> Self::EventIter { EventIter { current: 0, max: self.max, } } } impl MaxSet { /// Creates a `MaxSet` from the highest event. pub fn from(max: u64) -> Self { Self { max } } } pub struct EventIter { // Last value returned by the iterator current: u64, // Last value that should be returned by the iterator max: u64, } impl Iterator for EventIter { type Item = u64; fn next(&mut self) -> Option<Self::Item> { if self.current == self.max { // we've reached the end of the iterator None } else { // compute next value and return it self.current += 1; Some(self.current) } } } impl fmt::Debug for MaxSet { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!(f, "{}", self.max) } }