SeqAn3  3.0.3
The Modern C++ library for sequence analysis.
uint.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 
26 #pragma once
27 
30 
31 namespace seqan3::detail
32 {
36 template <typename type>
37 constexpr bool is_uint_adaptation_v = std::same_as<type, uint8_t> ||
38  std::same_as<type, uint16_t> ||
39  std::same_as<type, uint32_t>;
40 } // namespace seqan3::detail
41 
42 namespace seqan3::custom
43 {
44 
51 template <typename uint_type>
53  requires seqan3::detail::is_uint_adaptation_v<uint_type>
55 struct alphabet<uint_type>
56 {
61  static constexpr auto alphabet_size =
62  detail::min_viable_uint_t<detail::size_in_values_v<uint_type>>{detail::size_in_values_v<uint_type>};
63 
70  static constexpr auto to_char(uint_type const uint_v) noexcept
71  {
72  if constexpr (std::same_as<uint_type, uint8_t>)
73  return static_cast<char>(uint_v);
74  else if constexpr (std::same_as<uint_type, uint16_t>)
75  return static_cast<char16_t>(uint_v);
76  else
77  return static_cast<char32_t>(uint_v);
78  }
79 
86  static constexpr uint_type to_rank(uint_type const uint_v) noexcept
87  {
88  return uint_v;
89  }
90 
98  static constexpr uint_type & assign_char_to(decltype(to_char(uint_type{})) const chr, uint_type & uint_v) noexcept
99  {
100  return uint_v = chr;
101  }
102 
110  static constexpr uint_type & assign_rank_to(uint_type const uint2_v, uint_type & uint_v) noexcept
111  {
112  return uint_v = uint2_v;
113  }
114 };
115 
116 } // namespace seqan3::custom
Core alphabet concept and free function/type trait wrappers.
constexpr auto to_char
Return the char representation of an alphabet object.
Definition: concept.hpp:384
constexpr auto alphabet_size
A type trait that holds the size of a (semi-)alphabet.
Definition: concept.hpp:858
Provides metaprogramming utilities for integer types.
A namespace for third party and standard library specialisations of SeqAn customisation points.
Definition: char.hpp:44
static constexpr uint_type & assign_rank_to(uint_type const uint2_v, uint_type &uint_v) noexcept
Assign a rank to the uint (same as calling =).
Definition: uint.hpp:110
static constexpr uint_type & assign_char_to(decltype(to_char(uint_type{})) const chr, uint_type &uint_v) noexcept
Assign from a character type via implicit or explicit cast.
Definition: uint.hpp:98
static constexpr auto to_char(uint_type const uint_v) noexcept
Converting uint to char casts to a character type of same size.
Definition: uint.hpp:70
static constexpr uint_type to_rank(uint_type const uint_v) noexcept
Converting uint to rank is a no-op (it will just return the value you pass in).
Definition: uint.hpp:86
A type that can be specialised to provide customisation point implementations so that third party typ...
Definition: concept.hpp:49