dev/html/search__traits_8hpp_source.html

 // -----------------------------------------------------------------------------------------------------

 // Copyright (c) 2006-2020, Knut Reinert & Freie Universität Berlin

 // Copyright (c) 2016-2020, Knut Reinert & MPI für molekulare Genetik

 // This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License

 // shipped with this file and also available at: https://github.com/seqan/seqan3/blob/master/LICENSE.md

 // -----------------------------------------------------------------------------------------------------


 #pragma once


 #include <seqan3/core/detail/empty_type.hpp>

 #include <seqan3/search/configuration/max_error.hpp>

 #include <seqan3/search/configuration/hit.hpp>

 #include <seqan3/search/configuration/on_result.hpp>

 #include <seqan3/search/configuration/output.hpp>

 #include <seqan3/search/configuration/result_type.hpp>

 #include <seqan3/utility/type_traits/basic.hpp>


 namespace seqan3::detail

 {


 template <typename search_configuration_t>

 struct search_traits

 {

     using empty_search_result_type = search_result<empty_type, empty_type, empty_type, empty_type>;

     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;


     static constexpr bool has_max_error_total =

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

     static constexpr bool has_max_error_substitution =

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

     static constexpr bool has_max_error_insertion =

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

     static constexpr bool has_max_error_deletion =

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


     static constexpr bool only_max_error_total = has_max_error_total &&

                                                  !has_max_error_substitution &&

                                                  !has_max_error_insertion &&

                                                  !has_max_error_deletion;


     static constexpr bool search_all_hits = search_configuration_t::template exists<search_cfg::hit_all>();

     static constexpr bool search_single_best_hit = search_configuration_t::template exists<search_cfg::hit_single_best>();

     static constexpr bool search_all_best_hits = search_configuration_t::template exists<search_cfg::hit_all_best>();

     static constexpr bool search_strata_hits = search_configuration_t::template exists<search_cfg::hit_strata>();

     static constexpr bool has_hit_configuration = search_all_hits ||

                                                   search_single_best_hit ||

                                                   search_all_best_hits ||

                                                   search_strata_hits ||

                                                   search_configuration_t::template exists<search_cfg::hit>();


     static constexpr bool output_query_id = search_configuration_t::template exists<search_cfg::output_query_id>();

     static constexpr bool output_reference_id =

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

     static constexpr bool output_reference_begin_position =

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

     static constexpr bool output_index_cursor =

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

     static constexpr bool output_requires_locate_call = output_reference_id | output_reference_begin_position;


     static constexpr bool has_output_configuration = output_query_id |

                                                      output_reference_id |

                                                      output_reference_begin_position |

                                                      output_index_cursor;


     static constexpr bool has_user_callback = search_configuration_t::template exists<search_cfg::on_result>();

 };


 } // namespace seqan3::detail

seqan3::search_cfg::detail::result_type
Configuration element storing the configured seqan3::search_result for the search algorithm.
Definition: result_type.hpp:46

seqan3::search_result
The result class generated by the seqan3::seach algorithm.
Definition: search_result.hpp:82

empty_type.hpp
Provides seqan3::detail::empty_type.

hit.hpp
Provides the configuration to define the hit strategies "hit_strata", "hit_all", "hit_all_best",...

max_error.hpp
Provides the configuration for maximum number of errors for all error types.

seqan3::detail
The internal SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:29

on_result.hpp
Provides seqan3::search_cfg::on_result.

std::remove_cvref_t

result_type.hpp
Provides seqan3::search_cfg::detail::result_type.

output.hpp
Provides the configuration for the content of the search result.

seqan3::detail::search_traits
A collection of traits extracted from the search configuration.
Definition: search_traits.hpp:34

seqan3::detail::search_traits::search_strata_hits
static constexpr bool search_strata_hits
A flag indicating whether search should find strata hits.
Definition: search_traits.hpp:69

seqan3::detail::search_traits::has_max_error_deletion
static constexpr bool has_max_error_deletion
A flag indicating whether search should be invoked with deletion errors.
Definition: search_traits.hpp:53

seqan3::detail::search_traits::output_requires_locate_call
static constexpr bool output_requires_locate_call
A flag indicating whether it is required to call cursor.locate() to retrieve the respective informati...
Definition: search_traits.hpp:89

seqan3::detail::search_traits::has_max_error_total
static constexpr bool has_max_error_total
A flag indicating whether search should be invoked with total errors.
Definition: search_traits.hpp:44

seqan3::detail::search_traits::search_all_best_hits
static constexpr bool search_all_best_hits
A flag indicating whether search should find all best hits.
Definition: search_traits.hpp:67

seqan3::detail::search_traits::only_max_error_total
static constexpr bool only_max_error_total
A flag that indicates whether the search should be invoked with only specified total errors.
Definition: search_traits.hpp:57

seqan3::detail::search_traits::output_query_id
static constexpr bool output_query_id
A flag indicating whether search should return the query_id.
Definition: search_traits.hpp:78

seqan3::detail::search_traits::has_user_callback
static constexpr bool has_user_callback
A flag indicating whether a user provided callback was given.
Definition: search_traits.hpp:98

seqan3::detail::search_traits::search_single_best_hit
static constexpr bool search_single_best_hit
A flag indicating whether search should find best hits.
Definition: search_traits.hpp:65

seqan3::detail::search_traits::output_index_cursor
static constexpr bool output_index_cursor
A flag indicating whether search should return the index_cursor.
Definition: search_traits.hpp:86

seqan3::detail::search_traits::output_reference_id
static constexpr bool output_reference_id
A flag indicating whether search should return the reference_id.
Definition: search_traits.hpp:80

seqan3::detail::search_traits::search_all_hits
static constexpr bool search_all_hits
A flag indicating whether search should find all hits.
Definition: search_traits.hpp:63

seqan3::detail::search_traits::output_reference_begin_position
static constexpr bool output_reference_begin_position
A flag indicating whether search should return the reference_begin_position.
Definition: search_traits.hpp:83

seqan3::detail::search_traits::has_max_error_insertion
static constexpr bool has_max_error_insertion
A flag indicating whether search should be invoked with insertion errors.
Definition: search_traits.hpp:50

seqan3::detail::search_traits::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 search_result_type
The configured search result type.
Definition: search_traits.hpp:41

seqan3::detail::search_traits::has_output_configuration
static constexpr bool has_output_configuration
A flag indicating whether output configuration was set in the search configuration.
Definition: search_traits.hpp:92

seqan3::detail::search_traits::has_hit_configuration
static constexpr bool has_hit_configuration
A flag indicating whether hit configuration was set in the search configuration.
Definition: search_traits.hpp:71

seqan3::detail::search_traits::has_max_error_substitution
static constexpr bool has_max_error_substitution
A flag indicating whether search should be invoked with substitution errors.
Definition: search_traits.hpp:47

basic.hpp
Provides various type traits on generic types.