SeqAn3 3.1.0-rc.2
The Modern C++ library for sequence analysis.
align_config_method.hpp
Go to the documentation of this file.
1// -----------------------------------------------------------------------------------------------------
2// Copyright (c) 2006-2021, Knut Reinert & Freie Universität Berlin
3// Copyright (c) 2016-2021, Knut Reinert & MPI für molekulare Genetik
4// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License
5// shipped with this file and also available at: https://github.com/seqan/seqan3/blob/master/LICENSE.md
6// -----------------------------------------------------------------------------------------------------
7
16#pragma once
17
22
23namespace seqan3::align_cfg
24{
25
43{
44public:
48 method_local() = default;
49 method_local(method_local const &) = default;
50 method_local(method_local &&) = default;
51 method_local & operator=(method_local const &) = default;
53 ~method_local() = default;
54
56
59 static constexpr seqan3::detail::align_config_id id{seqan3::detail::align_config_id::local};
60};
61
65struct free_end_gaps_sequence1_leading : public seqan3::detail::strong_type<bool, free_end_gaps_sequence1_leading>
66{
68 using base_t = seqan3::detail::strong_type<bool, free_end_gaps_sequence1_leading>;
69 using base_t::base_t; // Import the base class constructors
70};
71
75struct free_end_gaps_sequence2_leading : public seqan3::detail::strong_type<bool, free_end_gaps_sequence2_leading>
76{
78 using base_t = seqan3::detail::strong_type<bool, free_end_gaps_sequence2_leading>;
79 using base_t::base_t; // Import the base class constructors
80};
81
85struct free_end_gaps_sequence1_trailing : public seqan3::detail::strong_type<bool, free_end_gaps_sequence1_trailing>
86{
88 using base_t = seqan3::detail::strong_type<bool, free_end_gaps_sequence1_trailing>;
89 using base_t::base_t; // Import the base class constructors
90};
91
95struct free_end_gaps_sequence2_trailing : public seqan3::detail::strong_type<bool, free_end_gaps_sequence2_trailing>
96{
98 using base_t = seqan3::detail::strong_type<bool, free_end_gaps_sequence2_trailing>;
99 using base_t::base_t; // Import the base class constructors
100};
101
107{
108public:
112 method_global() = default;
113 method_global(method_global const &) = default;
115 method_global & operator=(method_global const &) = default;
117 ~method_global() = default;
118
132 seqan3::align_cfg::free_end_gaps_sequence2_trailing free_sequence2_trailing) noexcept :
133 free_end_gaps_sequence1_leading{free_sequence1_leading.get()},
134 free_end_gaps_sequence2_leading{free_sequence2_leading.get()},
135 free_end_gaps_sequence1_trailing{free_sequence1_trailing.get()},
136 free_end_gaps_sequence2_trailing{free_sequence2_trailing.get()}
137 {}
139
148
151 static constexpr seqan3::detail::align_config_id id{seqan3::detail::align_config_id::global};
152};
153
154} // namespace seqan3::align_cfg
Sets the global alignment method.
Definition: align_config_method.hpp:107
method_global()=default
Defaulted.
bool free_end_gaps_sequence1_trailing
If set to true, trailing gaps in sequence1 are not penalised when computing the optimal alignment.
Definition: align_config_method.hpp:145
method_global & operator=(method_global const &)=default
Defaulted.
bool free_end_gaps_sequence2_trailing
If set to true, trailing gaps in sequence2 are not penalised when computing the optimal alignment.
Definition: align_config_method.hpp:147
method_global(method_global const &)=default
Defaulted.
constexpr method_global(seqan3::align_cfg::free_end_gaps_sequence1_leading free_sequence1_leading, seqan3::align_cfg::free_end_gaps_sequence2_leading free_sequence2_leading, seqan3::align_cfg::free_end_gaps_sequence1_trailing free_sequence1_trailing, seqan3::align_cfg::free_end_gaps_sequence2_trailing free_sequence2_trailing) noexcept
Construct method_global with a specific free end gap configuration.
Definition: align_config_method.hpp:129
method_global & operator=(method_global &&)=default
Defaulted.
~method_global()=default
Defaulted.
method_global(method_global &&)=default
Defaulted.
Sets the local alignment method.
Definition: align_config_method.hpp:43
method_local(method_local const &)=default
Defaulted.
~method_local()=default
Defaulted.
method_local()=default
Defaulted.
method_local(method_local &&)=default
Defaulted.
method_local & operator=(method_local const &)=default
Defaulted.
method_local & operator=(method_local &&)=default
Defaulted.
Provides seqan3::detail::empty_type.
A special sub namespace for the alignment configurations.
Definition: align_config_band.hpp:25
Provides seqan3::pipeable_config_element.
Provides basic data structure for strong types.
A strong type representing free_end_gaps_sequence1_leading of the seqan3::align_cfg::method_global.
Definition: align_config_method.hpp:66
seqan3::detail::strong_type< bool, free_end_gaps_sequence1_leading > base_t
The type of the strong type base class.
Definition: align_config_method.hpp:68
A strong type representing free_end_gaps_sequence1_trailing of the seqan3::align_cfg::method_global.
Definition: align_config_method.hpp:86
seqan3::detail::strong_type< bool, free_end_gaps_sequence1_trailing > base_t
The type of the strong type base class.
Definition: align_config_method.hpp:88
A strong type representing free_end_gaps_sequence2_leading of the seqan3::align_cfg::method_global.
Definition: align_config_method.hpp:76
seqan3::detail::strong_type< bool, free_end_gaps_sequence2_leading > base_t
The type of the strong type base class.
Definition: align_config_method.hpp:78
A strong type representing free_end_gaps_sequence2_trailing of the seqan3::align_cfg::method_global.
Definition: align_config_method.hpp:96
seqan3::detail::strong_type< bool, free_end_gaps_sequence2_trailing > base_t
The type of the strong type base class.
Definition: align_config_method.hpp:98
Adds pipe interface to configuration elements.
Definition: pipeable_config_element.hpp:30