nclist::OverlapsWithinParameters< Position_ > Struct Template Reference

Parameters for overlaps_within(). More...

#include <overlaps_within.hpp>

Public Attributes
std::optional< Position_ >	max_gap
Position_	min_overlap = 0
bool	quit_on_first = false

Detailed Description

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

Parameters for overlaps_within().

Template Parameters

Position_

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

Member Data Documentation

max_gap

template<typename Position_ >

std::optional<Position_> nclist::OverlapsWithinParameters< Position_ >::max_gap

Maximum difference between the lengths of the query and subject ranges. An overlap is not reported between a query/subject pair if the difference is greater than max_gap. If no value is set, the difference in lengths is not considered when reporting overlaps.

min_overlap

template<typename Position_ >

Position_ nclist::OverlapsWithinParameters< 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::OverlapsWithinParameters< 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_within.hpp