nclist::OverlapsAnyParameters< Position_ > Struct Template Reference

Parameters for overlaps_any(). More...

#include <overlaps_any.hpp>

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

Detailed Description

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

Parameters for overlaps_any().

Template Parameters

Position_

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

Member Data Documentation

max_gap

template<typename Position_ >

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

Maximum gap between query and subject intervals. If the gap between a query/subject pair is less than or equal to max_gap, the subject will be reported in matches even if it does not overlap with the query. For example, if max_gap = 0, a subject that is exactly contiguous with the query will still be reported. If max_gap has no value, only overlapping subjects will be reported. This is ignored if min_overlap is specified.

min_overlap

template<typename Position_ >

Position_ nclist::OverlapsAnyParameters< 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::OverlapsAnyParameters< 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_any.hpp