SeqAn3
align_config_output.hpp
Go to the documentation of this file.
1 // ============================================================================
2 // SeqAn - The Library for Sequence Analysis
3 // ============================================================================
4 //
5 // Copyright (c) 2006-2018, Knut Reinert & Freie Universitaet Berlin
6 // Copyright (c) 2016-2018, Knut Reinert & MPI Molekulare Genetik
7 // All rights reserved.
8 //
9 // Redistribution and use in source and binary forms, with or without
10 // modification, are permitted provided that the following conditions are met:
11 //
12 // * Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 // * Redistributions in binary form must reproduce the above copyright
15 // notice, this list of conditions and the following disclaimer in the
16 // documentation and/or other materials provided with the distribution.
17 // * Neither the name of Knut Reinert or the FU Berlin nor the names of
18 // its contributors may be used to endorse or promote products derived
19 // from this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 // ARE DISCLAIMED. IN NO EVENT SHALL KNUT REINERT OR THE FU BERLIN BE LIABLE
25 // FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 // LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 // OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
31 // DAMAGE.
32 //
33 // ============================================================================
34 
40 #pragma once
41 
47 
48 namespace seqan3::detail
49 {
53 template <align_result_key e>
54 struct align_config_output
55 {
57  align_result_key value{e};
58 };
59 
63 template <align_result_key e>
64 struct align_config_output_adaptor : public configuration_fn_base<align_config_output_adaptor<e>>
65 {
66  static_assert(e != align_result_key::id,
67  "The id field is only usable to recover the id of the alignment within the alignment result. "
68  "You need to at least use align_result_key::score for the alignment configuration.");
75  template <typename configuration_t>
77  requires is_algorithm_configuration_v<remove_cvref_t<configuration_t>>
79  constexpr auto invoke(configuration_t && cfg) const
80  {
81  static_assert(is_valid_alignment_configuration_v<align_cfg::id::output, remove_cvref_t<configuration_t>>,
82  SEQAN3_INVALID_CONFIG(align_cfg::id::output));
83 
84  return std::forward<configuration_t>(cfg).push_front(align_config_output<e>{});
85  }
86 };
87 
90 template <>
91 struct on_align_config<align_cfg::id::output>
92 {
94  template <config_element_concept t>
95  using invoke = typename is_value_specialisation_of<t, align_config_output>::type;
96 };
97 
100 template <align_result_key e>
101 struct align_config_type_to_id<align_config_output<e>>
102 {
104  static constexpr align_cfg::id value = align_cfg::id::output;
105 };
106 } // namespace seqan3::detail
107 
108 namespace seqan3::align_cfg
109 {
113 template <align_result_key e>
114 inline constexpr detail::align_config_output_adaptor<e> output;
115 } // namespace seqan3::align_cfg
constexpr detail::align_config_output_adaptor< e > output
A configuration adaptor for alignment output.
Definition: align_config_output.hpp:114
Identifier for output configuration.
Provides seqan3::type_list and auxiliary metafunctions.
A special sub namespace for the alignment configurations.
Definition: align_config_band.hpp:151
Provides functionality to access get function by enum values.
Definition: aligned_sequence_concept.hpp:288
id
Specifies an id for every configuration element.
Definition: utility.hpp:66
Provides various metafunctions on generic types.
align_result_key
Keys for different alignment results.
Definition: align_result.hpp:54
Provides seqan3::align_result.
Meta-Header for components of the algorithm submodule.