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 523 524 525 526 527 528 529 530 531 532 533 534
// Copyright 2018 Skylor R. Schermer. // // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your // option. This file may not be copied, modified, or distributed // except according to those terms. //////////////////////////////////////////////////////////////////////////////// //! //! Provides a bound type for intervals. //! //////////////////////////////////////////////////////////////////////////////// // Standard library imports. use std::borrow::Borrow; use std::default::Default; // Local enum shortcut. use self::Bound::*; //////////////////////////////////////////////////////////////////////////////// // Bound //////////////////////////////////////////////////////////////////////////////// /// Determines the type of an [`Interval`]'s boundary point. /// /// [`Interval`]: struct.Interval.html #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] pub enum Bound<T> { /// The bound includes the point. Include(T), /// The bound excludes the point. Exclude(T), /// The bound does not exist. Infinite, } impl<T> Bound<T> where T: PartialOrd + PartialEq + Clone { // Querying the contained values //////////////////////////////////////////////////////////////////////////// /// Returns `true` if the bound is an [`Include`] or [`Exclude`] value. /// /// [`Include`]: #variant.Include /// [`Exclude`]: #variant.Exclude /// /// # Example /// /// ```rust /// # use std::error::Error; /// # use interval::Bound; /// # fn main() -> Result<(), Box<dyn Error>> { /// # //------------------------------------------------------------------- /// let x: Bound<i32> = Bound::Include(15); /// assert_eq!(x.is_finite(), true); /// /// let x: Bound<i32> = Bound::Infinite; /// assert_eq!(x.is_finite(), false); /// # //------------------------------------------------------------------- /// # Ok(()) /// # } /// ``` #[inline] pub fn is_finite(&self) -> bool { match *self { Infinite => false, _ => true, } } /// Returns `true` if the bound is an [`Include`] value. /// /// [`Include`]: #variant.Include /// /// # Example /// /// ```rust /// # use std::error::Error; /// # use interval::Bound; /// # fn main() -> Result<(), Box<dyn Error>> { /// # //------------------------------------------------------------------- /// let x: Bound<i32> = Bound::Include(15); /// assert_eq!(x.is_inclusive(), true); /// /// let x: Bound<i32> = Bound::Exclude(15); /// assert_eq!(x.is_inclusive(), false); /// # //------------------------------------------------------------------- /// # Ok(()) /// # } /// ``` #[inline] pub fn is_inclusive(&self) -> bool { match *self { Include(_) => true, _ => false, } } /// Returns `true` if the bound is an [`Exclude`] value. /// /// [`Exclude`]: #variant.Exclude /// /// # Example /// /// ```rust /// # use std::error::Error; /// # use interval::Bound; /// # fn main() -> Result<(), Box<dyn Error>> { /// # //------------------------------------------------------------------- /// let x: Bound<i32> = Bound::Exclude(15); /// assert_eq!(x.is_exclusive(), true); /// /// let x: Bound<i32> = Bound::Include(15); /// assert_eq!(x.is_exclusive(), false); /// # //------------------------------------------------------------------- /// # Ok(()) /// # } /// ``` #[inline] pub fn is_exclusive(&self) -> bool { match *self { Exclude(_) => true, _ => false, } } // Adapter for working with references //////////////////////////////////////////////////////////////////////////// /// Returns a reference to the contained point, or `None` if the bound is /// [`Infinite`]. /// /// [`Infinite`]: #variant.Infinite /// /// # Example /// /// ```rust /// # use std::error::Error; /// # use interval::Bound; /// # fn main() -> Result<(), Box<dyn Error>> { /// # //------------------------------------------------------------------- /// let x: Bound<i32> = Bound::Exclude(34); /// /// assert_eq!(x.as_ref(), Some(&34)); /// # //------------------------------------------------------------------- /// # Ok(()) /// # } /// ``` #[inline] pub fn as_ref(&self) -> Option<&T> { match *self { Include(ref bound) => Some(bound), Exclude(ref bound) => Some(bound), Infinite => None, } } /// Returns a mutable reference to the contained point, or `None` if the /// bound is [`Infinite`]. /// /// [`Infinite`]: #variant.Infinite /// /// /// # Example /// /// ```rust /// # use std::error::Error; /// # use interval::Bound; /// # fn main() -> Result<(), Box<dyn Error>> { /// # //------------------------------------------------------------------- /// let mut x: Bound<i32> = Bound::Exclude(34); /// /// assert_eq!(x.as_mut(), Some(&mut 34)); /// # //------------------------------------------------------------------- /// # Ok(()) /// # } /// ``` #[inline] pub fn as_mut(&mut self) -> Option<&mut T> { match *self { Include(ref mut bound) => Some(bound), Exclude(ref mut bound) => Some(bound), Infinite => None, } } // Getting to contained values //////////////////////////////////////////////////////////////////////////// /// Moves the value out of the `Bound<T>` if it is [`Include`] or /// [`Exclude`]. /// /// In general, because this function may panic, its use is discouraged. /// Instead, prefer to use pattern matching and handle the [`Infinite`] /// case explicitly. /// /// [`Include`]: #variant.Include /// [`Exclude`]: #variant.Exclude /// [`Infinite`]: #variant.Infinite /// /// # Panics /// /// Panics if the self value equals [`Infinite`]. /// /// [`Infinite`]: #variant.Infinite /// /// # Examples /// /// ```rust /// # use std::error::Error; /// # use interval::Bound; /// # fn main() -> Result<(), Box<dyn Error>> { /// # //------------------------------------------------------------------- /// let x: Bound<i32> = Bound::Exclude(34); /// assert_eq!(x.unwrap(), 34); /// # //------------------------------------------------------------------- /// # Ok(()) /// # } /// ``` /// /// ```rust{.should_panic} /// # use std::error::Error; /// # use interval::Bound; /// # fn main() -> Result<(), Box<dyn Error>> { /// # //------------------------------------------------------------------- /// let x: Bound<i32> = Bound::Infinite; /// assert_eq!(x.unwrap(), 34); // fails /// # //------------------------------------------------------------------- /// # Ok(()) /// # } /// ``` #[inline] pub fn unwrap(self) -> T { match self { Include(x) => x, Exclude(x) => x, Infinite => panic!("called `Bound::unwrap()` on an `Infinite` value"), } } /// Returns the bound value or a default. /// /// # Example /// /// ```rust /// # use std::error::Error; /// # use interval::Bound; /// # fn main() -> Result<(), Box<dyn Error>> { /// # //------------------------------------------------------------------- /// assert_eq!(Bound::Exclude(34).unwrap_or(15), 34); /// assert_eq!(Bound::Infinite.unwrap_or(15), 15); /// # //------------------------------------------------------------------- /// # Ok(()) /// # } /// ``` #[inline] pub fn unwrap_or(self, def: T) -> T { match self { Include(x) => x, Exclude(x) => x, Infinite => def, } } /// Returns the bound value or computes it from a closure. /// /// # Example /// /// ```rust /// # use std::error::Error; /// # use interval::Bound; /// # fn main() -> Result<(), Box<dyn Error>> { /// # //------------------------------------------------------------------- /// let k = 10; /// assert_eq!(Bound::Exclude(34).unwrap_or_else(|| 2 * k), 34); /// assert_eq!(Bound::Infinite.unwrap_or_else(|| 2 * k), 20); /// # //------------------------------------------------------------------- /// # Ok(()) /// # } /// ``` #[inline] pub fn unwrap_or_else<F: FnOnce() -> T>(self, f: F) -> T { match self { Include(x) => x, Exclude(x) => x, Infinite => f(), } } // Transforming contained values //////////////////////////////////////////////////////////////////////////// /// Maps an `Bound<T>` to `Bound<U>` by applying a function to a contained /// value. /// /// # Example /// /// ```rust /// # use std::error::Error; /// # use interval::Bound; /// # fn main() -> Result<(), Box<dyn Error>> { /// # //------------------------------------------------------------------- /// let x: Bound<u32> = Bound::Include(10); /// let y: Bound<usize> = x.map(|v| v as usize); /// /// assert_eq!(y, Bound::Include(10usize)); /// # //------------------------------------------------------------------- /// # Ok(()) /// # } /// ``` #[inline] pub fn map<U, F: FnOnce(T) -> U>(self, f: F) -> Bound<U> { match self { Include(x) => Include(f(x)), Exclude(x) => Exclude(f(x)), Infinite => Infinite, } } /// Applyies a function to a contained value (if finite) or returns a /// default value (if [`Infinte`]). /// /// [`Infinite`]: #variant.Infinite /// /// # Example /// /// ```rust /// # use std::error::Error; /// # use interval::Bound; /// # fn main() -> Result<(), Box<dyn Error>> { /// # //------------------------------------------------------------------- /// assert_eq!(Bound::Include(10).map_or(6, |k| k * 2), 20); /// # //------------------------------------------------------------------- /// # Ok(()) /// # } /// ``` #[inline] pub fn map_or<U, F>(self, def: U, f: F) -> U where F: FnOnce(T) -> U { match self { Include(x) => f(x), Exclude(x) => f(x), Infinite => def, } } /// Applyies a function to a contained value (if finite) or returns a /// computed value (if [`Infinte`]). /// /// [`Infinite`]: #variant.Infinite /// /// # Example /// /// ```rust /// # use std::error::Error; /// # use interval::Bound; /// # fn main() -> Result<(), Box<dyn Error>> { /// # //------------------------------------------------------------------- /// assert_eq!(Bound::Include(10).map_or_else(|| 6, |k| k * 2), 20); /// assert_eq!(Bound::Infinite.map_or_else(|| 6, |k: u32| k * 2), 6); /// # //------------------------------------------------------------------- /// # Ok(()) /// # } /// ``` #[inline] pub fn map_or_else<U, D, F>(self, def: D, f: F) -> U where D: FnOnce() -> U, F: FnOnce(T) -> U { match self { Include(x) => f(x), Exclude(x) => f(x), Infinite => def(), } } // Transfering bound type //////////////////////////////////////////////////////////////////////////// /// Constructs a new `Bound` by applyting the bound type to the given value. /// /// # Example /// /// ```rust /// # use std::error::Error; /// # use interval::Bound; /// # fn main() -> Result<(), Box<dyn Error>> { /// # //------------------------------------------------------------------- /// let x: Bound<i32> = Bound::transfer(Bound::Exclude(34), 18); /// /// assert_eq!(x, Bound::Exclude(18)); /// # //------------------------------------------------------------------- /// # Ok(()) /// # } /// ``` #[inline] pub fn transfer<B: Borrow<Self>, O>(from: B, to: O) -> Bound<O> { match *from.borrow() { Include(_) => Include(to), Exclude(_) => Exclude(to), Infinite => Infinite, } } // Union and Intersection operators //////////////////////////////////////////////////////////////////////////// /// Returns the union of the given boundaries, or the lowest one if they are /// not at the same point. pub(in crate) fn least_union(&self, other: &Self) -> Self { match (self, other) { (&Include(ref p), &Include(ref o)) => if p < o {Include(p.clone())} else {Include(o.clone())}, (&Include(ref p), &Exclude(ref o)) => if p <= o {Include(p.clone())} else {Exclude(o.clone())}, (&Exclude(ref p), &Include(ref o)) => if p < o {Exclude(p.clone())} else {Include(o.clone())}, (&Exclude(ref p), &Exclude(ref o)) => if p < o {Exclude(p.clone())} else {Exclude(o.clone())}, _ => Infinite, } } /// Returns the intersect of the given boundaries, or the lowest one if they /// are not at the same point. pub(in crate) fn least_intersect(&self, other: &Self) -> Self { match (self, other) { (&Include(ref p), &Include(ref o)) => if p < o {Include(p.clone())} else {Include(o.clone())}, (&Include(ref p), &Exclude(ref o)) => if p < o {Include(p.clone())} else {Exclude(o.clone())}, (&Exclude(ref p), &Include(ref o)) => if p <= o {Exclude(p.clone())} else {Include(o.clone())}, (&Exclude(ref p), &Exclude(ref o)) => if p < o {Exclude(p.clone())} else {Exclude(o.clone())}, (&Include(ref p), &Infinite) => Include(p.clone()), (&Exclude(ref p), &Infinite) => Exclude(p.clone()), (&Infinite, &Include(ref o)) => Include(o.clone()), (&Infinite, &Exclude(ref o)) => Exclude(o.clone()), _ => Infinite, } } /// Returns the union of the given boundaries, or the greatest one if they /// are not at the same point. pub(in crate) fn greatest_union(&self, other: &Self) -> Self { match (self, other) { (&Include(ref p), &Include(ref o)) => if p > o {Include(p.clone())} else {Include(o.clone())}, (&Include(ref p), &Exclude(ref o)) => if p >= o {Include(p.clone())} else {Exclude(o.clone())}, (&Exclude(ref p), &Include(ref o)) => if p > o {Exclude(p.clone())} else {Include(o.clone())}, (&Exclude(ref p), &Exclude(ref o)) => if p > o {Exclude(p.clone())} else {Exclude(o.clone())}, _ => Infinite, } } /// Returns the intersect of the given boundaries, or the greatest one if /// they are not at the same point. pub(in crate) fn greatest_intersect(&self, other: &Self) -> Self { match (self, other) { (&Include(ref p), &Include(ref o)) => if p > o {Include(p.clone())} else {Include(o.clone())}, (&Include(ref p), &Exclude(ref o)) => if p > o {Include(p.clone())} else {Exclude(o.clone())}, (&Exclude(ref p), &Include(ref o)) => if p >= o {Exclude(p.clone())} else {Include(o.clone())}, (&Exclude(ref p), &Exclude(ref o)) => if p > o {Exclude(p.clone())} else {Exclude(o.clone())}, (&Include(ref p), &Infinite) => Include(p.clone()), (&Exclude(ref p), &Infinite) => Exclude(p.clone()), (&Infinite, &Include(ref o)) => Include(o.clone()), (&Infinite, &Exclude(ref o)) => Exclude(o.clone()), _ => Infinite, } } /// Returns `true` if the `Bound` points are considered adjacent under a /// union. pub(in crate) fn union_adjacent(&self, other: &Self) -> bool { match (self, other) { (&Include(ref p), &Include(ref o)) | (&Include(ref p), &Exclude(ref o)) | (&Exclude(ref p), &Include(ref o)) if p == o => true, _ => false, } } } // Default `Bound` is closed. impl<T> Default for Bound<T> where T: Default { #[inline] fn default() -> Self { Include(Default::default()) } } // `Bound`-from-point conversion. impl<T> From<T> for Bound<T> { #[inline] fn from(t: T) -> Self { Include(t) } }