seqan3::search_cfg::mode< mode_t > Struct Template Reference

Configuration element to determine the search mode. More...

#include <seqan3/search/algorithm/configuration/mode.hpp>

Inheritance diagram for seqan3::search_cfg::mode< mode_t >:

Public Attributes
mode_t	value
	The stored config value.

Related Functions
(Note that these are not member functions.)
Type deduction guides
template<typename mode_t >
	mode (mode_t) -> mode< remove_cvref_t< mode_t >>
	Deduces search mode type from constructor argument.

Detailed Description

template<typename mode_t>
struct seqan3::search_cfg::mode< mode_t >

Configuration element to determine the search mode.

This configuration element can be used to determine which hits are supported. Currently these modes are available:

Mode	Behaviour
seqan3::search_cfg::all	Report all hits within error bounds.
seqan3::search_cfg::all_best	Report all hits with the lowest number of errors within the bounds.
seqan3::search_cfg::best	Report one best hit (hit with lowest error) within bounds.
seqan3::search_cfg::strata	Report all hits within best + x errors.

Example

#include <seqan3/search/algorithm/configuration/all.hpp>

int main()
{
    using namespace seqan3;

    // Report the hit with the least number of errors (either 0 or 1 errors).
    configuration const cfg1 = search_cfg::max_error{search_cfg::total{1},
                                                     search_cfg::substitution{0},
                                                     search_cfg::insertion{1},
                                                     search_cfg::deletion{1}}
                               | search_cfg::mode{search_cfg::best};

    // Report all hits with best + 1 error. E.g., if the best hit has 1 error, all hits with 1 and 2 error are reported.
    configuration const cfg2 = search_cfg::max_error{search_cfg::substitution{0},
                                                     search_cfg::insertion{1},
                                                     search_cfg::deletion{1}}
                               | search_cfg::mode{search_cfg::strata{1}};
    return 0;
}

---

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

• seqan3/search/algorithm/configuration/mode.hpp