nclist::OverlapsEqualParameters< Position_ > Struct Template Reference

Parameters for overlaps_equal(). More...

#include <overlaps_equal.hpp>

Public Attributes
Position_	max_gap = 0
Position_	min_overlap = 0
bool	quit_on_first = false

Detailed Description

template<typename Position_>
struct nclist::OverlapsEqualParameters< Position_ >

Parameters for overlaps_equal().

Template Parameters

Position_

Numeric type for the start/end positions of each interval.

Member Data Documentation

max_gap

template<typename Position_ >

Position_ nclist::OverlapsEqualParameters< Position_ >::max_gap = 0

Maximum gap between the starts/ends of query and subject intervals. An overlap is reported between a query/subject pair if the gap between starts and the gap between ends are both equal to or less than max_gap.

min_overlap

template<typename Position_ >

Position_ nclist::OverlapsEqualParameters< Position_ >::min_overlap = 0

Minimum overlap between query and subject intervals. An overlap will not be reported if the length of the overlapping subinterval is less than min_overlap.

quit_on_first

template<typename Position_ >

bool nclist::OverlapsEqualParameters< Position_ >::quit_on_first = false

Whether to quit immediately upon identifying an overlap with the query interval. In such cases, matches will contain one arbitrarily chosen subject interval that overlaps with the query.

---

The documentation for this struct was generated from the following file:

• nclist/overlaps_equal.hpp