Struct Interval 

pub struct Interval<T> {
    pub lower: Bound<T>,
    pub upper: Bound<T>,
}

A mathematical interval described by a lower and upper bound.

Intervals may be open, closed, half-open, or unbounded on either side.

Examples

use use_interval::{Bound, Interval};

let closed = Interval::closed(1.0, 3.0);
let half_open = Interval::new(Bound::Closed(0.0), Bound::Open(1.0));

assert!(closed.contains(2.0));
assert!(half_open.contains(0.5));

Fields

lower: Bound<T>

The lower endpoint rule.

upper: Bound<T>

The upper endpoint rule.

Implementations

impl<T> Interval<T>

pub const fn new(lower: Bound<T>, upper: Bound<T>) -> Self

Creates an interval from explicit lower and upper bounds.

pub const fn open(lower: T, upper: T) -> Self

Creates an open interval (lower, upper).

pub const fn closed(lower: T, upper: T) -> Self

Creates a closed interval [lower, upper].

pub const fn open_closed(lower: T, upper: T) -> Self

Creates a half-open interval (lower, upper].

pub const fn closed_open(lower: T, upper: T) -> Self

Creates a half-open interval [lower, upper).

pub const fn greater_than(lower: T) -> Self

Creates the interval (lower, +inf).

pub const fn greater_than_or_equal(lower: T) -> Self

Creates the interval [lower, +inf).

pub const fn less_than(upper: T) -> Self

Creates the interval (-inf, upper).

pub const fn less_than_or_equal(upper: T) -> Self

Creates the interval (-inf, upper].

pub const fn unbounded() -> Self

Creates the interval (-inf, +inf).

impl<T: PartialOrd + Copy> Interval<T>

pub fn contains(&self, value: T) -> bool

Returns true when value lies inside the interval.

pub fn is_empty(&self) -> bool

Returns true when the interval contains no values.

(a, a), (a, a], and [a, a) are empty. [a, a] is not empty.

pub fn is_bounded(&self) -> bool

Returns true when the interval has both lower and upper bounds.

pub fn has_lower_bound(&self) -> bool

Returns true when the interval has a lower bound.

pub fn has_upper_bound(&self) -> bool

Returns true when the interval has an upper bound.

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

Returns true when the interval and other share at least one value.

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

Returns the intersection with other, or None when it is empty.

impl Interval<f64>

pub fn length(&self) -> Option<f64>

Returns the bounded interval length.

Returns None for unbounded intervals. Empty bounded intervals have length 0.0.

Trait Implementations

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

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> Debug for Interval<T>

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

Formats the value using the given formatter.

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

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: Copy> Copy for Interval<T>

impl<T> StructuralPartialEq for Interval<T>