Struct rust_lapper::Lapper

pub struct Lapper<T: Eq + Clone> {
    pub intervals: Vec<Interval<T>>,
    pub overlaps_merged: bool,
    // some fields omitted
}

Primary object of the library. The public intervals holds all the intervals and can be used for iterating / pulling values out of the tree.

Fields

intervals: Vec<Interval<T>>

overlaps_merged: bool

Methods

impl<T: Eq + Clone> Lapper<T>

pub fn new(intervals: Vec<Interval<T>>) -> Self

Create a new instance of Lapper by passing in a vector of Intervals. This vector will immediately be sorted by start order.

pub fn len(&self) -> usize

Get the number over intervals in Lapper

pub fn is_empty(&self) -> bool

Check if lapper is empty

pub fn cov(&self) -> usize

Get the number of positions covered by the intervals in Lapper. This provides immutable access if it has already been set, or on the fly calculation.

pub fn set_cov(&mut self) -> usize

Get the number fo positions covered by the intervals in Lapper and store it. If you are going to be using the coverage, you should set it to avoid calculating it over and over.

Important traits for IterLapper<'a, T>

impl<'a, T: Eq + Clone> Iterator for IterLapper<'a, T> type Item = &'a Interval<T>;

pub fn iter(&self) -> IterLapper<T>

Return an iterator over the intervals in Lapper

pub fn merge_overlaps(&mut self)

Merge any intervals that overlap with eachother within the Lapper. This is an easy way to speed up queries.

pub fn union_and_intersect(&self, other: &Self) -> (usize, usize)

Find the union and the intersect of two lapper objects. Union: The set of positions found in both lappers Intersect: The number of positions where both lappers intersect. Note that a position only counts one time, multiple Intervals covering the same position don't add up. TODO: a speedup should be available if merge overlaps has already been run

pub fn intersect(&self, other: &Self) -> usize

Find the intersect of two lapper objects. Intersect: The number of positions where both lappers intersect. Note that a position only counts one time, multiple Intervals covering the same position don't add up

pub fn union(&self, other: &Self) -> usize

Find the union of two lapper objects.

Important traits for IterFind<'a, T>

impl<'a, T: Eq + Clone> Iterator for IterFind<'a, T> type Item = &'a Interval<T>;

pub fn find(&self, start: usize, stop: usize) -> IterFind<T>

Find all intervals that overlap start .. stop

Important traits for IterFind<'a, T>

impl<'a, T: Eq + Clone> Iterator for IterFind<'a, T> type Item = &'a Interval<T>;

pub fn seek<'a>(
    &'a self,
    start: usize,
    stop: usize,
    cursor: &mut usize
) -> IterFind<'a, T>

Find all intevals that overlap start .. stop. This method will work when queries to this lapper are in sorted (start) order. It uses a linear search from the last query instead of a binary search. A reference to a cursor must be passed in. This reference will be modified and should be reused in the next query. This allows seek to not need to make the lapper object mutable, and thus use the same lapper accross threads.

Trait Implementations

impl<T: Eq + Clone> IntoIterator for Lapper<T>

type Item = Interval<T>

The type of the elements being iterated over.

type IntoIter = IntoIter<Self::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: Eq + Clone> IntoIterator for &'a Lapper<T>

type Item = &'a Interval<T>

The type of the elements being iterated over.

type IntoIter = Iter<'a, Interval<T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a, Interval<T>>

Creates an iterator from a value.

impl<'a, T: Eq + Clone> IntoIterator for &'a mut Lapper<T>

type Item = &'a mut Interval<T>

The type of the elements being iterated over.

type IntoIter = IterMut<'a, Interval<T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IterMut<'a, Interval<T>>

Creates an iterator from a value.

impl<T: Debug + Eq + Clone> Debug for Lapper<T>

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

Formats the value using the given formatter.