Struct LeftGroupedJoin 

pub struct LeftGroupedJoin {
    pub left: RangeTuple,
    pub rights: Vec<RangeTuple>,
}

LeftGroupedJoin contains information about the right ranges and their degree of overlap with a focal left range. This information is designed to facilitate downstream statistical sumamries of the corresponding data in overlapping ranges.

Fields

left: RangeTuple

The left range.

rights: Vec<RangeTuple>

A Vec of the right overlapping ranges (unsorted).

Implementations

impl LeftGroupedJoin

pub fn new<R: GenericRange>(left_range: &R) -> Self

Create a new LeftGroupedJoin.

pub fn add_right<R: GenericRange>(&mut self, right: &R)

Add a right (overlapping) range to this LeftGroupedJoin.

pub fn sort_ranges(&mut self)

Sort the right ranges, for faster downstream processing.

pub fn reduce_ranges(&mut self) -> Vec<RangeReduced>

“Reduce” the ranges into a minimum set, with all their indices gathered in a Vec<Option<usize>>. This returns a Vec<RangeReduced>.

pub fn has_overlaps(&self) -> bool

Return whether this left range has any LeftGroupedJoin.

pub fn num_overlaps(&self) -> usize

Retrieve the number of right overlaps.

pub fn overlaps(&self) -> Vec<Position>

Retrieve the right overlaps.

pub fn left_index(&self) -> Option<usize>

Get the left index.

pub fn right_indices(&self) -> Vec<Option<usize>>

Get the right indices.

Trait Implementations

impl Clone for LeftGroupedJoin

fn clone(&self) -> LeftGroupedJoin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LeftGroupedJoin

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

Formats the value using the given formatter.

impl PartialEq for LeftGroupedJoin

fn eq(&self, other: &LeftGroupedJoin) -> 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 StructuralPartialEq for LeftGroupedJoin