56 template <
typename derived_type, writable_semialphabet alphabet_type>
58 requires std::regular<alphabet_type>
63 alphabet_base<derived_type,
64 alphabet_size<alphabet_type>,
65 detail::valid_template_spec_or_t<void, alphabet_char_t, alphabet_type>>>
73 alphabet_size<alphabet_type>,
74 detail::valid_template_spec_or_t<void, alphabet_char_t, alphabet_type>>>;
80 using char_type = detail::valid_template_spec_or_t<char, alphabet_char_t, alphabet_type>;
83 using phred_type = detail::valid_template_spec_or_t<int8_t, alphabet_phred_t, alphabet_type>;
99 requires std::is_class_v<alphabet_type>
107 requires (!std::is_class_v<alphabet_type>)
115 constexpr derived_type & operator=(alphabet_type
const & c) noexcept
117 if constexpr (std::is_class_v<alphabet_type>)
122 static_cast<derived_type &
>(*this).on_update();
123 return static_cast<derived_type &
>(*this);
127 template <
typename indirect_assignable_type>
128 constexpr derived_type & operator=(indirect_assignable_type
const & c) noexcept
156 return operator=(tmp);
167 return operator=(tmp);
178 return operator=(tmp);
187 constexpr
operator alphabet_type() const noexcept
189 if constexpr (std::is_class_v<alphabet_type>)
210 template <
typename other_t>
212 requires (!std::is_class_v<alphabet_type>) && std::convertible_to<alphabet_type, other_t>
214 constexpr
operator other_t() const noexcept
216 return operator alphabet_type();
258 return char_is_valid_for<alphabet_type>(c);
269 template <
typename t>
270 static constexpr
bool is_alphabet_comparable_with = !std::is_same_v<derived_type, t> &&
271 detail::weakly_equality_comparable_with<alphabet_type, t>;
275 template <
typename t>
276 friend constexpr
auto operator==(derived_type
const lhs, t
const rhs) noexcept
279 return (lhs.operator alphabet_type() == rhs);
283 template <
typename t>
284 friend constexpr
auto operator==(t
const lhs, derived_type
const rhs) noexcept
291 template <
typename t>
292 friend constexpr
auto operator!=(derived_type
const lhs, t
const rhs) noexcept
295 return !(lhs == rhs);
299 template <
typename t>
300 friend constexpr
auto operator!=(t
const lhs, derived_type
const rhs) noexcept
Provides seqan3::nucleotide_alphabet.
Quality alphabet concept.
Provides seqan3::alphabet_base.
A CRTP-base that makes defining a custom alphabet easier.
Definition: alphabet_base.hpp:81
A CRTP-base that eases the definition of proxy types returned in place of regular alphabets.
Definition: alphabet_proxy.hpp:66
constexpr derived_type & assign_rank(alphabet_rank_t< alphabet_type > const r) noexcept
Assigns a rank.
Definition: alphabet_proxy.hpp:152
static constexpr bool char_is_valid(char_type const c) noexcept
Delegate to the emulated type's validator.
Definition: alphabet_proxy.hpp:253
static constexpr auto alphabet_size
The alphabet size.
Definition: alphabet_proxy.hpp:144
constexpr friend auto operator==(t const lhs, derived_type const rhs) noexcept -> std::enable_if_t< is_alphabet_comparable_with< t >, bool >
Allow (in-)equality comparison with types that the emulated type is comparable with.
Definition: alphabet_proxy.hpp:284
constexpr friend auto operator!=(t const lhs, derived_type const rhs) noexcept -> std::enable_if_t< is_alphabet_comparable_with< t >, bool >
Allow (in-)equality comparison with types that the emulated type is comparable with.
Definition: alphabet_proxy.hpp:300
constexpr friend auto operator==(derived_type const lhs, t const rhs) noexcept -> std::enable_if_t< is_alphabet_comparable_with< t >, bool >
Allow (in-)equality comparison with types that the emulated type is comparable with.
Definition: alphabet_proxy.hpp:276
constexpr auto to_phred() const noexcept
Returns the Phred score.
Definition: alphabet_proxy.hpp:235
constexpr alphabet_type complement() const noexcept
Returns the complement.
Definition: alphabet_proxy.hpp:244
constexpr auto to_char() const noexcept
Returns the character.
Definition: alphabet_proxy.hpp:226
constexpr derived_type & assign_char(char_type const c) noexcept
Assigns a character.
Definition: alphabet_proxy.hpp:160
constexpr derived_type & assign_phred(phred_type const c) noexcept
Assigns a Phred score.
Definition: alphabet_proxy.hpp:171
constexpr auto to_rank() const noexcept
Returns the rank.
Definition: alphabet_proxy.hpp:220
constexpr friend auto operator!=(derived_type const lhs, t const rhs) noexcept -> std::enable_if_t< is_alphabet_comparable_with< t >, bool >
Allow (in-)equality comparison with types that the emulated type is comparable with.
Definition: alphabet_proxy.hpp:292
Provides type traits for working with templates.
Provides concepts for core language types and relations that don't have concepts in C++20 (yet).
constexpr auto assign_char_to
Assign a character to an alphabet object.
Definition: concept.hpp:523
constexpr auto to_char
Return the char representation of an alphabet object.
Definition: concept.hpp:384
decltype(seqan3::to_rank(std::declval< semi_alphabet_type >())) alphabet_rank_t
The rank_type of the semi-alphabet; defined as the return type of seqan3::to_rank.
Definition: concept.hpp:164
constexpr auto assign_rank_to
Assign a rank to an alphabet object.
Definition: concept.hpp:291
constexpr auto to_rank
Return the rank representation of a (semi-)alphabet object.
Definition: concept.hpp:155
constexpr auto complement
Return the complement of a nucleotide object.
Definition: concept.hpp:104
constexpr auto to_phred
The public getter function for the Phred representation of a quality score.
Definition: concept.hpp:100
constexpr auto assign_phred_to
Assign a Phred score to a quality alphabet object.
Definition: concept.hpp:231
The generic alphabet concept that covers most data types used in ranges.
A concept that indicates whether an alphabet represents nucleotides.
A concept that indicates whether an alphabet represents quality scores.
Resolves to std::is_assignable_v<t>.
Refines seqan3::alphabet and adds assignability.
A concept that indicates whether a writable alphabet represents quality scores.
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:29
Provides various type traits on generic types.