Struct Interval

pub struct Interval<T>
where
    T: IntervalType,
{
    pub start: T,
    pub end: T,
}

Structure to represent an interval.

Fields

start: T

end: T

Implementations

impl<T> Interval<T>

where T: IntervalType,

pub fn new(low: T, high: T) -> Self

Constructs a new interval.

Example

use space_partitioning::interval_tree::Interval;
let interval = Interval::new(-2.0, 10.0);
assert_eq!(interval.start, -2.0);
assert_eq!(interval.end, 10.0);

pub fn overlaps_with(&self, other: &Interval<T>) -> bool

Checks whether the current interval overlaps with another one.

Example

use space_partitioning::interval_tree::Interval;
let interval = Interval::from(-2.0..=10.0);
assert!(interval.overlaps_with(&(0.0..=2.0).into()));
assert!(!interval.overlaps_with(&(20.0..=30.0).into()));

Trait Implementations

impl<T> Clone for Interval<T>

where T: IntervalType + Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Interval<T>

where T: Debug + IntervalType,

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

Formats the value using the given formatter.

impl<T> Default for Interval<T>

where T: IntervalType + Default,

fn default() -> Interval<T>

Returns the “default value” for a type.

impl<T> Display for Interval<T>

where T: Display + IntervalType,

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

Formats the value using the given formatter.

impl<T> From<&RangeInclusive<T>> for Interval<T>

where T: IntervalType,

fn from(range: &RangeInclusive<T>) -> Self

Constructs an interval from a `&RangeInclusive``.

Example

use space_partitioning::interval_tree::Interval;
let range = -2.0..=10.0;
let interval: Interval<_> = (&range).into();
assert_eq!(interval.start, -2.0);
assert_eq!(interval.end, 10.0);

impl<T> From<(T, T)> for Interval<T>

where T: IntervalType,

fn from(interval: (T, T)) -> Self

Constructs an interval from a tuple.

Example

use space_partitioning::interval_tree::Interval;
let interval: Interval<_> = (-2.0, 10.0).into();
assert_eq!(interval.start, -2.0);
assert_eq!(interval.end, 10.0);
assert_eq!(interval, Interval::from((-2.0, 10.0)));

impl<T> From<Interval<T>> for IntervalTree<T, ()>

where T: IntervalType,

fn from(interval: Interval<T>) -> Self

Converts to this type from the input type.

impl<T> From<RangeInclusive<T>> for Interval<T>

where T: IntervalType,

fn from(range: RangeInclusive<T>) -> Self

Constructs an interval from a `RangeInclusive``.

Example

use space_partitioning::interval_tree::Interval;
let interval: Interval<_> = (-2.0..=10.0).into();
assert_eq!(interval.start, -2.0);
assert_eq!(interval.end, 10.0);
assert_eq!(interval, Interval::from(-2.0..=10.0));

impl<T> Ord for Interval<T>

where T: IntervalType + Ord,

fn cmp(&self, other: &Interval<T>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<T> PartialEq for Interval<T>

where T: IntervalType + PartialEq,

fn eq(&self, other: &Interval<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> PartialOrd for Interval<T>

where T: IntervalType + PartialOrd,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T> Copy for Interval<T>

where T: IntervalType + Copy,

impl<T> Eq for Interval<T>

where T: IntervalType + Eq,

impl<T> StructuralPartialEq for Interval<T>

where T: IntervalType,