mode.hpp File Reference

Provides the mode configuration to define the search modes "all", "all_best", "best" and "strata". More...

#include <seqan3/core/algorithm/configuration.hpp>
#include <seqan3/core/algorithm/pipeable_config_element.hpp>
#include <seqan3/core/detail/strong_type.hpp>
#include <seqan3/core/type_traits/basic.hpp>
#include <seqan3/search/configuration/detail.hpp>

Include dependency graph for mode.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	seqan3::search_cfg::mode< mode_t >
	Configuration element to determine the search mode. More...
struct	seqan3::search_cfg::strata
	Configuration element to receive all hits with the best number of errors plus the strata value. A strong type of underlying type uint8_t that represents the number or errors for strata. All hits are found with the fewest numbererrors plus 'value'. More...

Namespaces
	seqan3
	The main SeqAn3 namespace.
	seqan3::search_cfg
	A special sub namespace for the search configurations.

Variables
constexpr detail::search_mode_all	seqan3::search_cfg::all
	Configuration element to receive all hits within the error bounds.
constexpr detail::search_mode_all_best	seqan3::search_cfg::all_best
	Configuration element to receive all hits within the lowest number of errors.
constexpr detail::search_mode_best	seqan3::search_cfg::best
	Configuration element to receive one best hit (with the lowest number of errors).

Detailed Description

Provides the mode configuration to define the search modes "all", "all_best", "best" and "strata".

Author

Christopher Pockrandt <christopher.pockrandt AT fu-berlin.de>

Rene Rahn <rene.rahn AT fu-berlin.de>