nclist::OverlapsStartParameters< Position_ > Struct Template Reference

Parameters for overlaps_start(). More...

#include <overlaps_start.hpp>

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

Detailed Description

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

Parameters for overlaps_start().

Template Parameters

Position_

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

Member Data Documentation

max_gap

template<typename Position_ >

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

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

min_overlap

template<typename Position_ >

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

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

quit_on_first

template<typename Position_ >

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

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

---

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

• nclist/overlaps_start.hpp