55template <
typename derived_type,
size_t size,
typename char_t =
char>
59 static_assert(
size != 0,
"alphabet size must be >= 1");
117 requires (!
std::same_as<char_t,
void>)
120 return derived_type::rank_to_char(rank);
167 requires (!std::same_as<char_t, void>)
170 rank = derived_type::char_to_rank(chr);
171 return static_cast<derived_type &
>(*this);
193 assert(
static_cast<size_t>(c) <
static_cast<size_t>(
alphabet_size));
195 return static_cast<derived_type &
>(*this);
212 friend constexpr bool operator==(derived_type
const lhs, derived_type
const rhs)
noexcept
221 friend constexpr bool operator!=(derived_type
const lhs, derived_type
const rhs)
noexcept
230 friend constexpr bool operator<(derived_type
const lhs, derived_type
const rhs)
noexcept
239 friend constexpr bool operator>(derived_type
const lhs, derived_type
const rhs)
noexcept
248 friend constexpr bool operator<=(derived_type
const lhs, derived_type
const rhs)
noexcept
257 friend constexpr bool operator>=(derived_type
const lhs, derived_type
const rhs)
noexcept
Core alphabet concept and free function/type trait wrappers.
A CRTP-base that makes defining a custom alphabet easier.
Definition: alphabet_base.hpp:57
constexpr char_type to_char() const noexcept
Return the letter as a character of char_type.
Definition: alphabet_base.hpp:115
constexpr friend bool operator==(derived_type const lhs, derived_type const rhs) noexcept
Checks whether the letters lhs and rhs are equal.
Definition: alphabet_base.hpp:212
constexpr friend bool operator>(derived_type const lhs, derived_type const rhs) noexcept
Checks whether the letter lhs is greater than rhs.
Definition: alphabet_base.hpp:239
constexpr derived_type & assign_char(char_type const chr) noexcept
Assign from a character, implicitly converts invalid characters.
Definition: alphabet_base.hpp:165
constexpr alphabet_base() noexcept=default
Defaulted.
constexpr rank_type to_rank() const noexcept
Return the letter's numeric value (rank in the alphabet).
Definition: alphabet_base.hpp:139
detail::min_viable_uint_t< size - 1 > rank_type
The type of the alphabet when represented as a number (e.g. via to_rank()).
Definition: alphabet_base.hpp:80
static constexpr detail::min_viable_uint_t< size > alphabet_size
The size of the alphabet, i.e. the number of different values it can take.
Definition: alphabet_base.hpp:203
constexpr friend bool operator<(derived_type const lhs, derived_type const rhs) noexcept
Checks whether the letter lhs is smaller than rhs.
Definition: alphabet_base.hpp:230
constexpr friend bool operator!=(derived_type const lhs, derived_type const rhs) noexcept
Checks whether the letters lhs and rhs are unequal.
Definition: alphabet_base.hpp:221
constexpr friend bool operator>=(derived_type const lhs, derived_type const rhs) noexcept
Checks whether the letter lhs is bigger than or equal to rhs.
Definition: alphabet_base.hpp:257
constexpr friend bool operator<=(derived_type const lhs, derived_type const rhs) noexcept
Checks whether the letter lhs is smaller than or equal to rhs.
Definition: alphabet_base.hpp:248
constexpr derived_type & assign_rank(rank_type const c) noexcept
Assign from a numeric value.
Definition: alphabet_base.hpp:191
The <concepts> header from C++20's standard library.
constexpr auto to_rank
Return the rank representation of a (semi-)alphabet object.
Definition: concept.hpp:155
constexpr size_t size
The size of a type pack.
Definition: traits.hpp:151
Provides metaprogramming utilities for integer types.
The main SeqAn3 namespace.
Definition: cigar_operation_table.hpp:2
SeqAn specific customisations in the standard namespace.
The <type_traits> header from C++20's standard library.