Struct RangeList

pub struct RangeList<E: PartialOrd> { /* private fields */ }

A sorted collection of inclusive ranges that can be used to represent non-continuous sets of values.

Warning

Although RangeList can be constructed for elements that do not implement std::cmp::Ord, but do implement std::cmp::PartialOrd, constructor methods, such as the FromIterator implementation, will panic if the used boundary values cannot be sorted. This requirement allows the usage of types like f64, as long as the user can guarantee that values that cannot be ordered, like NaN, will not appear.

Implementations

impl<E: PartialOrd> RangeList<E>

pub fn is_empty(&self) -> bool

Returns true if the range list contains no items.

Examples

assert!(!RangeList::from_iter([3..=4]).is_empty());
assert!(RangeList::<i64>::default().is_empty());
assert!(RangeList::from_iter([3..=2]).is_empty());

pub fn contains(&self, item: &E) -> bool

Returns true if item is contained in the range list.

Examples

assert!(RangeList::from_iter([1..=4]).contains(&4));
assert!(!RangeList::from_iter([1..=4]).contains(&0));

assert!(RangeList::from_iter([1..=4, 6..=7, -5..=-3]).contains(&7));
assert!(!RangeList::from_iter([1..=4, 6..=7, -5..=-3]).contains(&0));

pub fn lower_bound(&self) -> Option<&E>

Returns the lower bound of the range list, or None if the range list is empty.

Examples

assert_eq!(RangeList::from_iter([1..=4]).lower_bound(), Some(&1));
assert_eq!(RangeList::from_iter([1..=4, 6..=7, -5..=-3]).lower_bound(), Some(&-5));

assert_eq!(RangeList::<i64>::default().lower_bound(), None);

pub fn upper_bound(&self) -> Option<&E>

Returns the upper bound of the range list, or None if the range list is empty

Examples

assert_eq!(RangeList::from_iter([1..=4]).upper_bound(), Some(&4));
assert_eq!(RangeList::from_iter([1..=4, 6..=7, -5..=-3]).upper_bound(), Some(&7));

assert_eq!(RangeList::<i64>::default().upper_bound(), None);

impl<E: PartialOrd + Copy> RangeList<E>

pub fn iter<'a>( &'a self, ) -> Map<<&RangeList<E> as IntoIterator>::IntoIter, fn(RangeInclusive<&'a E>) -> RangeInclusive<E>>

Returns an Copying iterator for the ranges in the set.

Trait Implementations

impl<E: Clone + PartialOrd> Clone for RangeList<E>

fn clone(&self) -> RangeList<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: PartialOrd + Debug> Debug for RangeList<E>

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

Formats the value using the given formatter.

impl<E: Default + PartialOrd> Default for RangeList<E>

fn default() -> RangeList<E>

Returns the “default value” for a type.

impl<E: PartialOrd + Debug> Display for RangeList<E>

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

Formats the value using the given formatter.

impl<E: PartialOrd + Clone> From<&RangeInclusive<E>> for RangeList<E>

fn from(value: &RangeInclusive<E>) -> Self

Converts to this type from the input type.

impl<E: PartialOrd + Clone> From<RangeInclusive<E>> for RangeList<E>

fn from(value: RangeInclusive<E>) -> Self

Converts to this type from the input type.

impl<E, R> FromIterator<R> for RangeList<E>

where E: PartialOrd + Clone, R: Into<RangeInclusive<E>>,

fn from_iter<T: IntoIterator<Item = R>>(iter: T) -> Self

Creates a value from an iterator.

impl<E: Hash + PartialOrd> Hash for RangeList<E>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<E: PartialOrd + Clone> IntervalIterator<E> for RangeList<E>

type IntervalIter = <RangeList<E> as IntoIterator>::IntoIter

The type of the interval iterator.

fn intervals(&self) -> Self::IntervalIter

Returns an iterator over the ordered intervals.

fn card(&self) -> usize

where E: AsPrimitive<usize> + Integer,

Returns the number of elements contained within the RangeList.

fn diff<O, R>(&self, other: &O) -> R

where E: Clone + Integer, O: IntervalIterator<E>, R: FromIterator<RangeInclusive<E>>,

Compute RangeList without any of the elements in the ranges of other.

fn disjoint<O: IntervalIterator<E> + ?Sized>(&self, other: &O) -> bool

Returns whether self and other are disjoint sets

fn intersect<O, R>(&self, other: &O) -> R

where E: Clone, O: IntervalIterator<E>, R: FromIterator<RangeInclusive<E>>,

Return the set intersection of two interval iterators.

fn subset<O: IntervalIterator<E> + ?Sized>(&self, other: &O) -> bool

Returns whether self is a subset of other

fn superset<O: IntervalIterator<E> + ?Sized>(&self, other: &O) -> bool

Returns whether self is a superset of other

fn union<O, R>(&self, other: &O) -> R

where E: Clone, O: IntervalIterator<E>, R: FromIterator<RangeInclusive<E>>,

Return the set union of two interval iterators.

impl<'a, E: PartialOrd> IntoIterator for &'a RangeList<E>

type IntoIter = Map<Iter<'a, (E, E)>, fn(_: &'a (E, E)) -> RangeInclusive<&'a E>>

Which kind of iterator are we turning this into?

type Item = RangeInclusive<&'a E>

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<E: PartialOrd + Clone> IntoIterator for RangeList<E>

type IntoIter = Map<IntoIter<(E, E)>, fn(_: (E, E)) -> RangeInclusive<E>>

Which kind of iterator are we turning this into?

type Item = RangeInclusive<E>

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<E: PartialEq + PartialOrd> PartialEq for RangeList<E>

fn eq(&self, other: &RangeList<E>) -> 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<E: PartialOrd + PartialOrd> PartialOrd for RangeList<E>

fn partial_cmp(&self, other: &RangeList<E>) -> 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<E: Eq + PartialOrd> Eq for RangeList<E>

impl<E: PartialOrd> StructuralPartialEq for RangeList<E>