Struct Interval

Source
pub struct Interval<T: Ord> { /* private fields */ }
Expand description

A utility data structure to represent intervals. It supports open, close and unbounded intervals

§Examples

use store_interval_tree::Interval;
use std::ops::Bound::*;

// initialize interval [2,4]
let interval1 = Interval::new(Included(2), Included(4));

// initialize interval [2,4)
let interval2 = Interval::new(Included(2), Excluded(4));

// initialize point [4,4]
let point1 = Interval::point(4);

// compare intervals
// first, lower bounds are compared. if they're equal, higher bounds will be compared
assert!(interval2 < interval1);

// check if two intervals overlap
assert!(Interval::overlaps(&interval1, &interval2));

// check if one point and an interval overlap
assert!(Interval::overlaps(&interval1, &point1));
assert!(!Interval::overlaps(&interval2, &point1));

// check if one interval contains another interval
assert!(Interval::contains(&interval1, &interval2));

// get overlapped interval between two intervals
assert!(Interval::get_overlap(&interval1, &interval2).unwrap() == interval2);

Implementations§

Source§

impl<T: Ord> Interval<T>

Source

pub fn new(low: Bound<T>, high: Bound<T>) -> Interval<T>

Creates a new interval

§Arguments
  • low: lower bound of the interval
  • high: higher bound of the interval
§Panics
  • panics if low > high. low == high is acceptable if interval is closed at both sides: [low, high]
§Example
use store_interval_tree::Interval;
use std::ops::Bound::*;

// create the interval [2,4)
let interval1 = Interval::new(Included(2), Excluded(4));

// create the interval (-inf,4)
let interval2 = Interval::new(Unbounded, Excluded(4));


// create the interval (1,+inf)
let interval3 = Interval::new(Excluded(1), Unbounded);
Source

pub fn point(value: T) -> Interval<T>

Creates a point.

§Arguments
  • value: value of the point
§Examples
use store_interval_tree::Interval;
use std::ops::Bound::*;

// create point (2) or equivalently interval [2,2]
let point1 = Interval::point(2);
Source

pub fn duplicate(&self) -> Interval<T>

Creates a duplicate of the interval

§Examples
use store_interval_tree::Interval;
use std::ops::Bound::*;

let interval = Interval::new(Included(2), Unbounded);
let duplicate = interval.duplicate();

assert!(interval == duplicate);
Source

pub fn low(&self) -> &Bound<T>

Get reference to lower bound of the interval

Source

pub fn get_low(&self) -> Rc<Bound<T>>

Get a duplicate of lower bound of the interval

Source

pub fn high(&self) -> &Bound<T>

Get reference to higher bound of the interval

Source

pub fn get_high(&self) -> Rc<Bound<T>>

Get a duplicate of higher bound of the interval

Source

pub fn overlaps(first: &Interval<T>, second: &Interval<T>) -> bool

Returns true if first and second intervals overlap, false otherwise

§Examples
use store_interval_tree::Interval;
use std::ops::Bound::*;

let interval1 = Interval::new(Included(2), Included(4));
let interval2 = Interval::new(Included(2), Excluded(4));
let point1 = Interval::point(4);

assert!(Interval::overlaps(&interval1, &interval2));
assert!(Interval::overlaps(&interval1, &point1));
assert!(!Interval::overlaps(&interval2, &point1));
Source

pub fn contains(first: &Interval<T>, second: &Interval<T>) -> bool

Returns true if second is a sub-interval of first, false otherwise

§Examples
use store_interval_tree::Interval;
use std::ops::Bound::*;

let interval1 = Interval::new(Included(2), Included(4));
let interval2 = Interval::new(Included(2), Excluded(4));

assert!(Interval::contains(&interval1, &interval2));
Source

pub fn get_overlap( first: &Interval<T>, second: &Interval<T>, ) -> Option<Interval<T>>

Get overlapped interval of first and second, None otherwise

§Examples
use store_interval_tree::Interval;
use std::ops::Bound::*;

// initialize intervals
let interval1 = Interval::new(Included(2), Included(4));
let interval2 = Interval::new(Included(2), Excluded(4));

assert!(Interval::get_overlap(&interval1, &interval2).unwrap() == interval2);
Source§

impl<T: Copy + Num + Ord> Interval<T>

Source

pub fn span(&self) -> Option<T>

Returns the span between the start and the end of the interval. None if the interval is unbounded.

Trait Implementations§

Source§

impl<T: Clone + Ord> Clone for Interval<T>

Source§

fn clone(&self) -> Interval<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + Ord> Debug for Interval<T>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<T: Ord + Display> Display for Interval<T>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<T: Hash + Ord> Hash for Interval<T>

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<T: Ord> Ord for Interval<T>

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<T: Ord> PartialEq for Interval<T>

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T: Ord> PartialOrd for Interval<T>

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<T: Ord> Eq for Interval<T>

Auto Trait Implementations§

§

impl<T> Freeze for Interval<T>

§

impl<T> RefUnwindSafe for Interval<T>
where T: RefUnwindSafe,

§

impl<T> !Send for Interval<T>

§

impl<T> !Sync for Interval<T>

§

impl<T> Unpin for Interval<T>

§

impl<T> UnwindSafe for Interval<T>
where T: RefUnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.