29 namespace seqan3::detail
35 class search_configurator
44 template <
typename search_configuration_t,
typename index_t,
typename query_index_t>
45 struct select_search_result
49 using index_cursor_type =
typename index_t::cursor_type;
51 using index_size_type =
typename index_t::size_type;
53 using traits_type = search_traits<search_configuration_t>;
62 using reference_begin_position_t =
std::conditional_t<traits_type::output_reference_begin_position,
68 using type = search_result<query_id_t, index_cursor_t, reference_id_t, reference_begin_position_t>;
77 template <
typename configuration_t,
typename index_t,
typename ...policies_t>
78 struct select_search_algorithm
82 lazy_conditional_t<bi_fm_index_specialisation<index_t>,
83 lazy<search_scheme_algorithm, configuration_t, index_t, policies_t...>,
84 lazy<unidirectional_search_algorithm, configuration_t, index_t, policies_t...>>;
98 template <
typename configuration_t>
99 static auto add_default_hit_configuration(configuration_t
const & cfg)
101 if constexpr (!detail::search_traits<configuration_t>::has_hit_configuration)
102 return cfg | search_cfg::hit_all{};
116 template <
typename configuration_t>
117 static auto add_default_output_configuration(configuration_t
const & cfg)
119 if constexpr (!seqan3::detail::search_traits<configuration_t>::has_output_configuration)
121 search_cfg::output_query_id{} |
122 search_cfg::output_reference_id{} |
123 search_cfg::output_reference_begin_position{};
140 template <
typename configuration_t>
141 static auto add_defaults(configuration_t
const & cfg)
143 static_assert(detail::is_type_specialisation_of_v<configuration_t, configuration>,
144 "cfg must be a specialisation of seqan3::configuration.");
146 auto cfg1 = add_default_hit_configuration(cfg);
147 auto cfg2 = add_default_output_configuration(cfg1);
167 template <
typename query_t,
typename configuration_t,
typename index_t>
168 static auto configure_algorithm(configuration_t
const & cfg, index_t
const & index)
170 using query_index_t = std::tuple_element_t<0, query_t>;
171 using search_result_t =
typename select_search_result<configuration_t, index_t, query_index_t>::type;
173 using type_erased_algorithm_t =
std::function<void(query_t, callback_t)>;
175 auto complete_config = cfg | search_cfg::detail::result_type<search_result_t>{};
176 return std::pair{configure_hit_strategy<type_erased_algorithm_t>(complete_config, index), complete_config};
179 template <
typename algorithm_t,
typename configuration_t,
typename index_t>
180 static algorithm_t configure_hit_strategy(configuration_t
const &, index_t
const &);
196 template <
typename algorithm_t,
typename configuration_t,
typename index_t>
197 static algorithm_t select_and_return_algorithm(configuration_t
const & config, index_t
const & index)
199 using selected_algorithm_t =
200 typename select_search_algorithm<configuration_t,
203 policy_search_result_builder<configuration_t>>::type;
205 return selected_algorithm_t{config, index};
229 template <
typename algorithm_t,
typename configuration_t,
typename index_t>
230 algorithm_t search_configurator::configure_hit_strategy(configuration_t
const & cfg, index_t
const & index)
233 auto next_config_step = [&] (
auto new_cfg) -> algorithm_t
235 return select_and_return_algorithm<algorithm_t>(new_cfg, index);
239 if constexpr (configuration_t::template exists<search_cfg::hit>())
241 auto hit_variant = get<search_cfg::hit>(cfg).hit_variant;
243 if (std::holds_alternative<empty_type>(hit_variant))
245 "Please refer to the configuration documentation of the search algorithm for "
249 auto cfg_without_hit = cfg.template remove<search_cfg::hit>();
254 [&] (search_cfg::hit_all_best) {
return next_config_step(cfg_without_hit | search_cfg::hit_all_best{}); },
255 [&] (search_cfg::hit_single_best) {
return next_config_step(cfg_without_hit | search_cfg::hit_single_best{}); },
256 [&] (search_cfg::hit_strata
const & strata) {
return next_config_step(cfg_without_hit | strata); },
257 [&] (
auto) {
return next_config_step(cfg_without_hit | search_cfg::hit_all{}); }
262 static_assert(detail::search_traits<configuration_t>::has_hit_configuration,
263 "The hit strategy for the search algorithm was not configured. "
264 "Please refer to the configuration documentation of the search algorithm for more details.");
266 return next_config_step(cfg);