Struct im_interval_tree::Interval

pub struct Interval<T: Ord + Clone> { /* fields omitted */ }

A data structure for representing intervals

Implementations

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

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

Construct a new Interval from two Bounds

Example

use std::ops::Bound::*;
let interval = Interval::new(Included(3), Excluded(5));

pub fn get_overlap(&self, other: &Self) -> Option<Self>

Get the overlap between two Intervals

Example

let interval = Interval::new(Included(1), Excluded(3));
let overlaps = Interval::new(Included(2), Excluded(4));
let no_overlap = Interval::new(Included(3), Excluded(4));

assert_eq!(
    interval.get_overlap(&overlaps),
    Some(Interval::new(Included(2), Excluded(3)))
);

assert_eq!(interval.get_overlap(&no_overlap), None);

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

Check whether two intervals overlap

Example

let interval = Interval::new(Included(1), Excluded(3));
let overlaps = Interval::new(Included(2), Excluded(4));
let no_overlap = Interval::new(Included(3), Excluded(4));

assert_eq!(interval.overlaps(&overlaps), true);
assert_eq!(interval.overlaps(&no_overlap), false);

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

Check whether an interval contains another

Example

let interval = Interval::new(Included(1), Excluded(4));
let contained = Interval::new(Included(2), Excluded(3));
let not_contained = Interval::new(Included(2), Excluded(6));

assert_eq!(interval.contains(&contained), true);
assert_eq!(interval.contains(&not_contained), false);

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

Return the lower bound

Example

let interval = Interval::new(Included(3), Excluded(5));
assert_eq!(interval.low(), &Included(3))

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

Return the upper bound

Example

let interval = Interval::new(Included(3), Excluded(5));
assert_eq!(interval.high(), &Excluded(5))

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

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

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

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

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

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

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.