SeqAn3
seqan3::band_static< value_t > Struct Template Reference

Data structure for a static band. More...

#include <seqan3/alignment/configuration/align_config_band_static.hpp>

Related Functions

(Note that these are not member functions.)

Deduction guides
template<std::Integral value_t>
 band_static (lower_bound< value_t >, upper_bound< value_t >) -> band_static< value_t >
 Deduces the band type. More...
 

Constructors, destructor and assignment

 band_static ()=default
 
 band_static (band_static const &)=default
 
 band_static (band_static &&)=default
 
band_staticoperator= (band_static const &)=default
 
band_staticoperator= (band_static &&)=default
 
 ~band_static ()=default
 
template<std::Integral input_value_t>
constexpr band_static (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

template<std::Integral value_t>
struct seqan3::band_static< value_t >

Data structure for a static band.

Template Parameters
value_tThe value type for the boundaries; must model std::integral.

Constructor & Destructor Documentation

◆ band_static()

template<std::Integral value_t>
template<std::Integral input_value_t>
constexpr seqan3::band_static< value_t >::band_static ( 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.

Friends And Related Function Documentation

◆ band_static()

template<std::Integral value_t>
band_static ( lower_bound< value_t >  ,
upper_bound< value_t >   
) -> band_static< value_t >
related

Deduces the band type.

Template Parameters
value_tThe underlying type of the boundaries; must model std::integral.

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