SeqAn3  3.0.2
The Modern C++ library for sequence analysis.
seqan3::static_band Class Reference

Data structure for a static band. More...

#include <seqan3/alignment/band/static_band.hpp>

Constructors, destructor and assignment

int64_t lower_bound {std::numeric_limits<int64_t>::lowest()}
 } More...
 
int64_t upper_bound {std::numeric_limits<int64_t>::max()}
 The data member storing the upper boundary of the band.
 
constexpr static_band () noexcept=default
 Defaulted.
 
constexpr static_band (static_band const &) noexcept=default
 Defaulted.
 
constexpr static_band (static_band &&) noexcept=default
 Defaulted.
 
constexpr static_bandoperator= (static_band const &) noexcept=default
 Defaulted.
 
constexpr static_bandoperator= (static_band &&) noexcept=default
 Defaulted.
 
 ~static_band () noexcept=default
 Defaulted.
 
template<std::integral input_value_t>
constexpr static_band (lower_bound< input_value_t > const lower, upper_bound< input_value_t > const upper)
 Construction from seqan3::lower_bound and seqan3::upper_bound. More...
 

Detailed Description

Data structure for a static band.

Constructor & Destructor Documentation

◆ static_band()

template<std::integral input_value_t>
constexpr seqan3::static_band::static_band ( lower_bound< input_value_t > const  lower,
upper_bound< input_value_t > const  upper 
)
inline

Construction from seqan3::lower_bound and seqan3::upper_bound.

Template Parameters
input_value_tThe input type of the lower and upper band boundaries.
Parameters
lowerThe lower boundary of the band; must model std::integral.
upperThe upper boundary of the band; must model std::integral.
Exceptions
std::invalid_argumentif upper < lower.

The boundaries denote the maximum allowed inbalance of insertions and deletions in the alignment. For a symmetric band, choose lower = -upper. The upper boundary must not be smaller than the lower boundary.

Member Data Documentation

◆ lower_bound

int64_t seqan3::static_band::lower_bound {std::numeric_limits<int64_t>::lowest()}

}

The data member storing the lower boundary of the band.


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