SeqAn3 3.4.0-rc.1
The Modern C++ library for sequence analysis.
Loading...
Searching...
No Matches
char.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
23#pragma once
24
27
28namespace seqan3::detail
29{
33template <typename type>
34constexpr bool is_char_adaptation_v = std::same_as<type, char> || std::same_as<type, char16_t>
35 || std::same_as<type, char32_t> || std::same_as<type, wchar_t>;
36} // namespace seqan3::detail
37
39{
40
47template <typename char_type>
48 requires detail::is_char_adaptation_v<char_type>
49struct alphabet<char_type>
50{
55 static constexpr auto alphabet_size =
56 detail::min_viable_uint_t<detail::size_in_values_v<char_type>>{detail::size_in_values_v<char_type>};
57
64 static constexpr char_type to_char(char_type const chr) noexcept
65 {
66 return chr;
67 }
68
75 static constexpr auto to_rank(char_type const chr) noexcept
76 {
77 return static_cast<detail::min_viable_uint_t<alphabet_size - 1>>(chr);
78 }
79
87 static constexpr char_type & assign_char_to(char_type const chr2, char_type & chr) noexcept
88 {
89 return chr = chr2;
90 }
91
99 static constexpr char_type & assign_rank_to(decltype(alphabet::to_rank(char_type{})) const rank,
100 char_type & chr) noexcept
101 {
102 return chr = rank;
103 }
104};
105
106} // namespace seqan3::custom
Core alphabet concept and free function/type trait wrappers.
constexpr auto alphabet_size
A type trait that holds the size of a (semi-)alphabet.
Definition alphabet/concept.hpp:846
Provides metaprogramming utilities for integer types.
A namespace for third party and standard library specialisations of SeqAn customisation points.
Definition char.hpp:39
static constexpr auto to_rank(char_type const chr) noexcept
Convert char to rank by casting to an unsigned integral type of same size.
Definition char.hpp:75
static constexpr char_type & assign_char_to(char_type const chr2, char_type &chr) noexcept
Assign a char to the char type (same as calling =).
Definition char.hpp:87
static constexpr char_type to_char(char_type const chr) noexcept
Converting char to char is no-op (it will just return the value you pass in).
Definition char.hpp:64
static constexpr char_type & assign_rank_to(decltype(alphabet::to_rank(char_type{})) const rank, char_type &chr) noexcept
Assigning a rank to a char is the same as assigning it a numeric value.
Definition char.hpp:99
A type that can be specialised to provide customisation point implementations so that third party typ...
Definition alphabet/concept.hpp:46
Hide me