seqan3::align_cfg::max_error Struct Reference

Sets the maximal errors allowed during an edit distance computation. More...

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

Inheritance diagram for seqan3::align_cfg::max_error:

Public Attributes
uint32_t	value
	The stored config value.

Detailed Description

Sets the maximal errors allowed during an edit distance computation.

This configuration can only be used for computing the edit distance. It restricts the number of substitutions, insertions, and deletions within the alignment to the given value and can thereby speed up the edit distance computation. A typical use case is to verify a candidate region during read mapping where the number of maximal errors is given beforehand. If this configuration is used for an alignment algorithm that does not compute the edit distance, a seqan3::invalid_alignment_configuration exception will be thrown.

Example

#include <seqan3/alignment/configuration/align_config_max_error.hpp>
 
int main()
{
    // Allow maximal 5 errors.
    seqan3::align_cfg::max_error cfg{5u};
}

---

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

• seqan3/alignment/configuration/align_config_max_error.hpp