A collection of traits extracted from the search configuration. More...

#include <seqan3/search/detail/search_traits.hpp>

Public Types
using	empty_search_result_type = search_result< empty_type, empty_type, empty_type, empty_type >
	A specific empty search result type indicating misconfiguration of the search algorithm.

using	search_result_type = typename std::remove_cvref_t< decltype(std::declval< search_configuration_t >().get_or(search_cfg::detail::result_type< empty_search_result_type >{})) >::type
	The configured search result type.

Static Public Attributes
static constexpr bool	has_hit_configuration
	A flag indicating whether hit configuration was set in the search configuration. More...

static constexpr bool	has_max_error_deletion
	A flag indicating whether search should be invoked with deletion errors. More...

static constexpr bool	has_max_error_insertion
	A flag indicating whether search should be invoked with insertion errors. More...

static constexpr bool	has_max_error_substitution
	A flag indicating whether search should be invoked with substitution errors. More...

static constexpr bool	has_max_error_total
	A flag indicating whether search should be invoked with total errors. More...

static constexpr bool	has_output_configuration
	A flag indicating whether output configuration was set in the search configuration. More...

static constexpr bool	has_user_callback = search_configuration_t::template exists<search_cfg::on_result>()
	A flag indicating whether a user provided callback was given.

static constexpr bool	only_max_error_total
	A flag that indicates whether the search should be invoked with only specified total errors. More...

static constexpr bool	output_index_cursor
	A flag indicating whether search should return the index_cursor. More...

static constexpr bool	output_query_id = search_configuration_t::template exists<search_cfg::output_query_id>()
	A flag indicating whether search should return the query_id.

static constexpr bool	output_reference_begin_position
	A flag indicating whether search should return the reference_begin_position. More...

static constexpr bool	output_reference_id
	A flag indicating whether search should return the reference_id. More...

static constexpr bool	output_requires_locate_call = output_reference_id \| output_reference_begin_position
	A flag indicating whether it is required to call cursor.locate() to retrieve the respective information.

static constexpr bool	search_all_best_hits = search_configuration_t::template exists<search_cfg::hit_all_best>()
	A flag indicating whether search should find all best hits.

static constexpr bool	search_all_hits = search_configuration_t::template exists<search_cfg::hit_all>()
	A flag indicating whether search should find all hits.

static constexpr bool	search_single_best_hit = search_configuration_t::template exists<search_cfg::hit_single_best>()
	A flag indicating whether search should find best hits.

static constexpr bool	search_strata_hits = search_configuration_t::template exists<search_cfg::hit_strata>()
	A flag indicating whether search should find strata hits.

Detailed Description

template<typename search_configuration_t>
struct seqan3::detail::search_traits< search_configuration_t >

A collection of traits extracted from the search configuration.

Template Parameters

search_configuration_t The type of the search algorithm configuration; must be of type seqan3::configuration.

Member Data Documentation

◆ has_hit_configuration

template<typename search_configuration_t >

constexpr bool seqan3::detail::search_traits< search_configuration_t >::has_hit_configuration

staticconstexpr

Initial value:

= search_all_hits ||
                                                  search_single_best_hit ||
                                                  search_all_best_hits ||
                                                  search_strata_hits ||
                                                  search_configuration_t::template exists<search_cfg::hit>()

A flag indicating whether hit configuration was set in the search configuration.

◆ has_max_error_deletion

template<typename search_configuration_t >

constexpr bool seqan3::detail::search_traits< search_configuration_t >::has_max_error_deletion

staticconstexpr

Initial value:

=

search_configuration_t::template exists<search_cfg::max_error_deletion>()

A flag indicating whether search should be invoked with deletion errors.

◆ has_max_error_insertion

template<typename search_configuration_t >

constexpr bool seqan3::detail::search_traits< search_configuration_t >::has_max_error_insertion

staticconstexpr

Initial value:

=

search_configuration_t::template exists<search_cfg::max_error_insertion>()

A flag indicating whether search should be invoked with insertion errors.

◆ has_max_error_substitution

template<typename search_configuration_t >

constexpr bool seqan3::detail::search_traits< search_configuration_t >::has_max_error_substitution

staticconstexpr

Initial value:

=

search_configuration_t::template exists<search_cfg::max_error_substitution>()

A flag indicating whether search should be invoked with substitution errors.

◆ has_max_error_total

template<typename search_configuration_t >

constexpr bool seqan3::detail::search_traits< search_configuration_t >::has_max_error_total

staticconstexpr

Initial value:

=

search_configuration_t::template exists<search_cfg::max_error_total>()

A flag indicating whether search should be invoked with total errors.

◆ has_output_configuration

template<typename search_configuration_t >

constexpr bool seqan3::detail::search_traits< search_configuration_t >::has_output_configuration

staticconstexpr

Initial value:

= output_query_id |
                                                     output_reference_id |
                                                     output_reference_begin_position |
                                                     output_index_cursor

A flag indicating whether output configuration was set in the search configuration.

◆ only_max_error_total

template<typename search_configuration_t >

constexpr bool seqan3::detail::search_traits< search_configuration_t >::only_max_error_total

staticconstexpr

Initial value:

= has_max_error_total &&
                                                 !has_max_error_substitution &&
                                                 !has_max_error_insertion &&
                                                 !has_max_error_deletion

A flag that indicates whether the search should be invoked with only specified total errors.

◆ output_index_cursor

template<typename search_configuration_t >

constexpr bool seqan3::detail::search_traits< search_configuration_t >::output_index_cursor

staticconstexpr

Initial value:

=

search_configuration_t::template exists<search_cfg::output_index_cursor>()

A flag indicating whether search should return the index_cursor.

◆ output_reference_begin_position

template<typename search_configuration_t >

constexpr bool seqan3::detail::search_traits< search_configuration_t >::output_reference_begin_position

staticconstexpr

Initial value:

=

search_configuration_t::template exists<search_cfg::output_reference_begin_position>()

A flag indicating whether search should return the reference_begin_position.

◆ output_reference_id

template<typename search_configuration_t >

constexpr bool seqan3::detail::search_traits< search_configuration_t >::output_reference_id

staticconstexpr

Initial value:

=

search_configuration_t::template exists<search_cfg::output_reference_id>()

A flag indicating whether search should return the reference_id.

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

seqan3/search/detail/search_traits.hpp

Public Types

Static Public Attributes

Detailed Description

Member Data Documentation

◆ has_hit_configuration

◆ has_max_error_deletion

◆ has_max_error_insertion

◆ has_max_error_substitution

◆ has_max_error_total

◆ has_output_configuration

◆ only_max_error_total

◆ output_index_cursor

◆ output_reference_begin_position

◆ output_reference_id