nclist::NearestParameters< Position_ > Struct Template Reference

Parameters for nearest(). More...

#include <nearest.hpp>

Public Attributes
bool	quit_on_first = false
bool	adjacent_equals_overlap = false

Detailed Description

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

Parameters for nearest().

Template Parameters

Position_

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

Member Data Documentation

adjacent_equals_overlap

template<typename Position_ >

bool nclist::NearestParameters< Position_ >::adjacent_equals_overlap = false

Whether to consider immediately-adjacent subject intervals to be equally "nearest" to the query as an overlapping subject interval. If true, both overlapping and immediately-adjacent subject intervals (i.e., a gap of zero) will be reported in matches. Otherwise, immediately-adjacent subjects will only be reported if overlapping subjects are not present.

quit_on_first

template<typename Position_ >

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

Whether to quit immediately upon identifying the nearest subject interval to the query interval. In such cases, matches will contain one arbitrarily chosen subject interval that is nearest to the query.

---

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

• nclist/nearest.hpp