seqan3::align_cfg::band< band_t > Struct Template Reference

Configuration element for setting the band. More...

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

Inheritance diagram for seqan3::align_cfg::band< band_t >:

Public Attributes
band_t	value
	The stored config value.

Related Functions
(Note that these are not member functions.)
Type deduction guides
template<typename band_t >
	band (band_t) -> band< band_t >
	Deduces the underlying band type. More...

Detailed Description

template<typename band_t>
struct seqan3::align_cfg::band< band_t >

Configuration element for setting the band.

Template Parameters

band_t

The type of the band.

Configures the banded alignment algorithm. Currently only seqan3::static_band is allowed as argument. If no band is configured for the alignment algorithm the full alignment matrix will be computed. Before executing the algorithm the band is tested for valid settings, e.g. that the upper bound is not smaller than the lower bound, or the band is not shifted out of the alignment matrix. If an invalid setting is detected, a seqan3::invalid_alignment_configuration exception will be thrown.

Example

#include <seqan3/alignment/band/static_band.hpp>
#include <seqan3/alignment/configuration/align_config_band.hpp>
 
int main()
{
try
{
    // A symmetric band around the main diagonal.
    seqan3::align_cfg::band band_cfg{seqan3::static_band{seqan3::lower_bound{-4}, seqan3::upper_bound{4}}};
 
    // A band starting with the main diagonal shifted by 3 cells to the right.
    seqan3::align_cfg::band band_cfg_hi{seqan3::static_band{seqan3::lower_bound{3}, seqan3::upper_bound{7}}};
 
    // A band starting with the main diagonal shifted by 3 cells down.
    seqan3::align_cfg::band band_cfg_lo{seqan3::static_band{seqan3::lower_bound{-7}, seqan3::upper_bound{-3}}};
 
    // An invalid band configuration.
    seqan3::align_cfg::band band_cfg_invalid{seqan3::static_band{seqan3::lower_bound{7}, seqan3::upper_bound{3}}};
}
catch(...)
{
}
}

Friends And Related Function Documentation

band()

template<typename band_t >

band ( band_t  ) -> band< band_t >

related

Deduces the underlying band type.

Template Parameters

band_t

The underlying type of the band.

---

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

• seqan3/alignment/configuration/align_config_band.hpp