Struct nclist::NClist

pub struct NClist<T> where
    T: Interval,  { /* fields omitted */ }

Methods

impl<T> NClist<T> where
    T: Interval, 

pub fn from_vec(v: Vec<T>) -> Result<NClist<T>, &'static str>

pub fn count_overlaps(&self, r: &Range<T::Coord>) -> usize

Count the number of elements overlapping the Range r. Counting overlaps is slightly faster than iterating over the overlaps. This method is preferred when only the number of overlapping elements is required.

Important traits for Overlaps<'a, T>

impl<'a, T> Iterator for Overlaps<'a, T> where
    T: Interval,  type Item = &'a T;

pub fn overlaps<'a>(&'a self, r: &'a Range<T::Coord>) -> Overlaps<'a, T>

Returns an iterator that returns overlapping elements to query r. During iteration contained intervals are pushed to a queue an processed in order after yielding the non-overlapping regions.

Important traits for OrderedOverlaps<'a, T>

impl<'a, T> Iterator for OrderedOverlaps<'a, T> where
    T: Interval,  type Item = &'a T;

pub fn overlaps_ordered<'a>(
    &'a self,
    r: &'a Range<T::Coord>
) -> OrderedOverlaps<'a, T>

Returns an iterator that returns overlapping elements to query r ordered by start coordinate. This is less efficient that returning without ordering, but doesn't require allocating storage for all overlapping elements.

pub fn into_vec(self) -> Vec<T>

Return the intervals Vec. This will run without allocation and return the intervals in a different order then provided.

Trait Implementations

impl<T: Debug> Debug for NClist<T> where
    T: Interval, 

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

Formats the value using the given formatter.

impl<T> Into<Vec<T>> for NClist<T> where
    T: Interval, 

Return the intervals Vec. This will run without allocation and return the intervals in a different order then provided.

fn into(self) -> Vec<T>

Performs the conversion.

impl<T> TryFrom<Vec<T>> for NClist<T> where
    T: Interval, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(v: Vec<T>) -> Result<Self, Self::Error>

Performs the conversion.