SeqAn3 3.4.0-rc.1
The Modern C++ library for sequence analysis.
Loading...
Searching...
No Matches
predicate_detail.hpp
Go to the documentation of this file.
1// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin
2// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik
3// SPDX-License-Identifier: BSD-3-Clause
4
11#pragma once
12
13#include <array>
14#include <cctype>
15#include <concepts>
16#include <stdexcept>
17#include <string>
18
22
23namespace seqan3::detail
24{
25
26// ----------------------------------------------------------------------------
27// constexpr_pseudo_bitset (could be replaced with constexpr std::bitset or github.com/ClaasBontus/bitset2)
28// ----------------------------------------------------------------------------
29
34template <size_t N>
35class constexpr_pseudo_bitset : public std::array<bool, N>
36{
37private:
39 using base_t = std::array<bool, N>;
40
41public:
43 using base_t::base_t;
44
46 constexpr constexpr_pseudo_bitset operator|(constexpr_pseudo_bitset rhs) const noexcept
47 {
48 for (size_t i = 0; i < N; ++i)
49 rhs[i] = rhs[i] || base_t::operator[](i);
50
51 return rhs;
52 }
54 constexpr constexpr_pseudo_bitset operator~() const noexcept
55 {
56 constexpr_pseudo_bitset ret{};
57 for (size_t i = 0; i < N; ++i)
58 ret[i] = !base_t::operator[](i);
59
60 return ret;
61 }
62};
63
64// ----------------------------------------------------------------------------
65// condition_message_v
66// ----------------------------------------------------------------------------
67
76template <char op, typename condition_head_t, typename... condition_ts>
77inline const std::string condition_message_v{
78 std::string{"("}
79 + (condition_head_t::msg + ... + (std::string{" "} + std::string{{op, op}} + std::string{" "} + condition_ts::msg))
80 + std::string{")"}};
81
82// ----------------------------------------------------------------------------
83// char_predicate
84// ----------------------------------------------------------------------------
85
87template <typename condition_t>
88struct char_predicate_base;
90
101template <typename condition_t>
102concept char_predicate = requires {
103 requires std::predicate<std::remove_reference_t<condition_t>, char>;
104 requires std::is_base_of_v<char_predicate_base<std::remove_cvref_t<condition_t>>,
106
108
109 //The msg type can be added with a std::string.
110 {
112 } -> std::convertible_to<decltype(std::remove_reference_t<condition_t>::msg)>;
113 };
115
135
136// ----------------------------------------------------------------------------
137// char_predicate
138// ----------------------------------------------------------------------------
139
141template <char_predicate... condition_ts>
142 requires (sizeof...(condition_ts) >= 2)
143struct char_predicate_disjunction;
144
145template <char_predicate condition_t>
146struct char_predicate_negator;
148
155template <typename derived_t>
156struct char_predicate_base
157{
159 using data_t = constexpr_pseudo_bitset<257>; // sizeof(char) plus EOF
160
166 template <char_predicate rhs_t>
167 constexpr auto operator||(rhs_t const &) const
168 {
169 return char_predicate_disjunction<derived_t, rhs_t>{};
170 }
171
173 constexpr auto operator!() const
174 {
175 return char_predicate_negator<derived_t>{};
176 }
178
183 template <std::integral value_t>
184 constexpr bool operator()(value_t const val) const noexcept
185 requires (sizeof(value_t) == 1)
186 {
187 return derived_t::data[static_cast<unsigned char>(val)];
188 }
189
191 template <std::integral value_t>
192 constexpr bool operator()(value_t const val) const noexcept
193 requires (sizeof(value_t) != 1)
194 {
195 // std::char_traits is only guaranteed to be defined for character types.
196 // libc++ deprecates other specialisations in llvm-17, and removes them in llvm-18.
197 // We map the non-character types to corresponding chracter types.
198 // For example, `seqan3::is_eof(EOF)` will call this function with `value_t == int`.
199 // clang-format off
200 using char_value_t = std::conditional_t<seqan3::builtin_character<value_t>, value_t,
206 void>>>>>>;
207 // clang-format on
208 static_assert(!std::same_as<char_value_t, void>, "There is no valid character representation.");
209 using char_trait = std::char_traits<char_value_t>;
210 return (static_cast<std::make_unsigned_t<value_t>>(val) < 256) ? operator()(static_cast<uint8_t>(val))
211 : (char_trait::eq_int_type(val, char_trait::eof())) ? derived_t::data[256]
212 : false;
213 }
215
220 std::string message() const
221 {
222 return derived_t::msg;
223 }
225};
226
227// ----------------------------------------------------------------------------
228// char_predicate_disjunction
229// ----------------------------------------------------------------------------
230
237template <char_predicate... condition_ts>
238 requires (sizeof...(condition_ts) >= 2)
239struct char_predicate_disjunction : public char_predicate_base<char_predicate_disjunction<condition_ts...>>
240{
242 static inline const std::string msg = detail::condition_message_v<'|', condition_ts...>;
243
245 using base_t = char_predicate_base<char_predicate_disjunction<condition_ts...>>;
246
248 using typename base_t::data_t;
250 static constexpr data_t data = (condition_ts::data | ...);
251};
252
259template <char_predicate condition_t>
260struct char_predicate_negator : public char_predicate_base<char_predicate_negator<condition_t>>
261{
263 static inline const std::string msg = std::string{'!'} + condition_t::msg;
264
266 using base_t = char_predicate_base<char_predicate_negator<condition_t>>;
267
269 using typename base_t::data_t;
271 static constexpr data_t data = ~condition_t::data;
272};
273
274// ----------------------------------------------------------------------------
275// is_in_interval_type
276// ----------------------------------------------------------------------------
277
286template <uint8_t interval_first, uint8_t interval_last>
287 requires (interval_first <= interval_last)
288struct is_in_interval_type : public char_predicate_base<is_in_interval_type<interval_first, interval_last>>
289{
291 static inline const std::string msg = std::string{"is_in_interval<'"} + std::string{interval_first}
292 + std::string{"', '"} + std::string{interval_last} + std::string{"'>"};
293
295 using base_t = char_predicate_base<is_in_interval_type<interval_first, interval_last>>;
296
298 using typename base_t::data_t;
300 static constexpr data_t data = []() constexpr
301 {
302 data_t ret{};
303
304 for (size_t i = interval_first; i <= static_cast<size_t>(interval_last); ++i)
305 ret[i] = true;
306
307 return ret;
308 }();
309};
310
311// ----------------------------------------------------------------------------
312// is_char_type
313// ----------------------------------------------------------------------------
314
320template <int char_v>
321struct is_char_type : public char_predicate_base<is_char_type<char_v>>
322{
323 static_assert(char_v == EOF || static_cast<uint64_t>(char_v) < 256, "TODO");
324
326 static inline const std::string msg =
327 std::string{"is_char<'"} + ((char_v == EOF) ? std::string{"EOF"} : std::string{char_v}) + std::string{"'>"};
328
330 using base_t = char_predicate_base<is_char_type<char_v>>;
331
333 using typename base_t::data_t;
335 static constexpr data_t data = []() constexpr
336 {
337 data_t ret{};
338
339 if (char_v == EOF)
340 ret[256] = true;
341 else
342 ret[static_cast<uint8_t>(char_v)] = true;
343
344 return ret;
345 }();
346};
347
348} // namespace seqan3::detail
Provides various type traits on generic types.
T data(T... args)
auto operator|(validator1_type &&vali1, validator2_type &&vali2)
Enables the chaining of validators.
Definition validators.hpp:1121
Provides traits to inspect some information of a type, for example its name.
Provides concepts that do not have equivalents in C++20.
Hide me