SeqAn3
align_config_band_static.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 
44 #include <seqan3/std/concepts>
45 
46 namespace seqan3
47 {
48 
53 template <seqan3::arithmetic_concept value_t>
54 struct lower_bound : detail::strong_type<value_t, lower_bound<value_t>>
55 {
57  using detail::strong_type<value_t, lower_bound<value_t>>::strong_type;
58 };
59 
64 template <seqan3::arithmetic_concept value_t>
65 struct upper_bound : detail::strong_type<value_t, upper_bound<value_t>>
66 {
68  using detail::strong_type<value_t, upper_bound<value_t>>::strong_type;
69 };
70 
79 template <seqan3::arithmetic_concept value_t>
81 
86 template <seqan3::arithmetic_concept value_t>
89 
95 template <std::Integral value_t>
97 {
101  band_static() = default;
102  band_static(band_static const &) = default;
103  band_static(band_static &&) = default;
104  band_static & operator=(band_static const &) = default;
105  band_static & operator=(band_static &&) = default;
106  ~band_static() = default;
107 
119  template <std::Integral input_value_t>
121  : lower_bound{lower.get()}, upper_bound{upper.get()}
122  {
123  if (lower.get() > upper.get())
124  {
125  throw std::invalid_argument("An error occurred in the static band configuration: "
126  "The upper boundary must not be smaller than the lower boundary.");
127  }
128  }
130 
133  value_t lower_bound{std::numeric_limits<value_t>::max()};
135  value_t upper_bound{std::numeric_limits<value_t>::max()};
136 };
137 
147 template <std::Integral value_t>
150 
151 } // namespace seqan3
Contains basic data structure for strong types.
Provides concepts for core language types and relations that don&#39;t have concepts in C++20 (yet)...
lower_bound(value_t) -> lower_bound< value_t >
Deduces the underlying lower boundary type.
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:58
Data structure for a static band.
Definition: align_config_band_static.hpp:96
The Concepts library.
constexpr detail::align_config_band_adaptor< seqan3::band_static > band_static
A configuration adaptor for a static band.
Definition: align_config_band.hpp:156
Type for a lower boundary.
Definition: align_config_band_static.hpp:54
Type for an upper boundary.
Definition: align_config_band_static.hpp:65
constexpr band_static(lower_bound< input_value_t > const lower, upper_bound< input_value_t > const upper)
Construction from seqan3::lower_bound and seqan3::upper_bound.
Definition: align_config_band_static.hpp:120