53 template <
typename derived_type,
size_t size,
typename char_t =
char>
57 static_assert(
size != 0,
"alphabet size must be >= 1");
111 requires (!
std::same_as<char_t,
void>)
114 return derived_type::rank_to_char[rank];
161 requires (!std::same_as<char_t, void>)
165 rank = derived_type::char_to_rank[
static_cast<index_t
>(c)];
166 return static_cast<derived_type &
>(*this);
188 assert(
static_cast<size_t>(c) <
static_cast<size_t>(
alphabet_size));
190 return static_cast<derived_type &
>(*this);
207 friend constexpr
bool operator==(derived_type
const lhs, derived_type
const rhs) noexcept
216 friend constexpr
bool operator!=(derived_type
const lhs, derived_type
const rhs) noexcept
225 friend constexpr
bool operator<(derived_type
const lhs, derived_type
const rhs) noexcept
234 friend constexpr
bool operator>(derived_type
const lhs, derived_type
const rhs) noexcept
243 friend constexpr
bool operator<=(derived_type
const lhs, derived_type
const rhs) noexcept
252 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:55
constexpr char_type to_char() const noexcept
Return the letter as a character of char_type.
Definition: alphabet_base.hpp:109
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:207
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:234
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:133
constexpr derived_type & assign_char(char_type const c) noexcept
Assign from a character, implicitly converts invalid characters.
Definition: alphabet_base.hpp:159
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:74
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:198
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:225
constexpr derived_type & assign_rank(rank_type const c) noexcept
Assign from a numeric value.
Definition: alphabet_base.hpp:186
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:216
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:252
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:243
constexpr auto to_rank
Return the rank representation of a (semi-)alphabet object.
Definition: concept.hpp:146
constexpr size_t size
The size of a type pack.
Definition: traits.hpp:150
Provides metaprogramming utilities for integer types.
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:29
SeqAn specific customisations in the standard namespace.
Provides C++20 additions to the type_traits header.