57template <
typename derived_type, writable_semialphabet alphabet_type>
58 requires std::regular<alphabet_type>
62 alphabet_base<derived_type,
63 alphabet_size<alphabet_type>,
64 detail::valid_template_spec_or_t<void, alphabet_char_t, alphabet_type>>>
72 alphabet_size<alphabet_type>,
73 detail::valid_template_spec_or_t<void, alphabet_char_t, alphabet_type>>>;
79 using char_type = detail::valid_template_spec_or_t<char, alphabet_char_t, alphabet_type>;
82 using phred_type = detail::valid_template_spec_or_t<int8_t, alphabet_phred_t, alphabet_type>;
97 requires std::is_class_v<alphabet_type>
103 requires (!std::is_class_v<alphabet_type>)
110 constexpr derived_type & operator=(alphabet_type
const & c)
noexcept
112 if constexpr (std::is_class_v<alphabet_type>)
117 static_cast<derived_type &
>(*this).on_update();
118 return static_cast<derived_type &
>(*this);
122 template <
typename indirect_assignable_type>
123 constexpr derived_type & operator=(indirect_assignable_type
const & c)
noexcept
149 return operator=(tmp);
158 return operator=(tmp);
167 return operator=(tmp);
176 constexpr operator alphabet_type() const noexcept
178 if constexpr (std::is_class_v<alphabet_type>)
199 template <
typename other_t>
200 requires (!std::is_class_v<alphabet_type>) && std::convertible_to<alphabet_type, other_t>
201 constexpr operator other_t()
const noexcept
203 return operator alphabet_type();
237 return char_is_valid_for<alphabet_type>(c);
249 template <
typename t>
250 static constexpr bool is_alphabet_comparable_with =
251 !std::is_same_v<derived_type, t> && detail::weakly_equality_comparable_with<alphabet_type, t>;
255 template <
typename t>
256 friend constexpr auto operator==(derived_type
const lhs, t
const rhs)
noexcept
259 return (lhs.operator alphabet_type() == rhs);
263 template <
typename t>
264 friend constexpr auto operator==(t
const lhs, derived_type
const rhs)
noexcept
271 template <
typename t>
272 friend constexpr auto operator!=(derived_type
const lhs, t
const rhs)
noexcept
275 return !(lhs == rhs);
279 template <
typename t>
280 friend constexpr auto operator!=(t
const lhs, derived_type
const rhs)
noexcept
Provides alphabet helper concepts.
Provides seqan3::nucleotide_alphabet.
Quality alphabet concept.
Provides seqan3::alphabet_base.
Provides various type traits on generic types.
A CRTP-base that makes defining a custom alphabet easier.
Definition: alphabet_base.hpp:57
A CRTP-base that eases the definition of proxy types returned in place of regular alphabets.
Definition: alphabet_proxy.hpp:65
friend constexpr 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:272
constexpr derived_type & assign_char(char_type const c) noexcept
Assigns a character.
Definition: alphabet_proxy.hpp:153
constexpr derived_type & assign_rank(alphabet_rank_t< alphabet_type > const r) noexcept
Assigns a rank.
Definition: alphabet_proxy.hpp:145
static constexpr auto alphabet_size
The alphabet size.
Definition: alphabet_proxy.hpp:137
constexpr derived_type & assign_phred(phred_type const c) noexcept
Assigns a Phred score.
Definition: alphabet_proxy.hpp:162
friend constexpr 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:280
friend constexpr 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:264
friend constexpr 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:256
constexpr alphabet_type complement() const noexcept
Returns the complement.
Definition: alphabet_proxy.hpp:227
constexpr auto to_char() const noexcept
Returns the character.
Definition: alphabet_proxy.hpp:213
constexpr auto to_phred() const noexcept
Returns the Phred score.
Definition: alphabet_proxy.hpp:220
constexpr auto to_rank() const noexcept
Returns the rank.
Definition: alphabet_proxy.hpp:207
static constexpr bool char_is_valid(char_type const c) noexcept
Delegate to the emulated type's validator.
Definition: alphabet_proxy.hpp:234
constexpr auto complement
Return the complement of a nucleotide object.
Definition: concept.hpp:105
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:230
constexpr auto assign_char_to
Assign a character to an alphabet object.
Definition: concept.hpp:524
constexpr auto to_char
Return the char representation of an alphabet object.
Definition: concept.hpp:386
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:169
constexpr auto assign_rank_to
Assign a rank to an alphabet object.
Definition: concept.hpp:293
constexpr auto to_rank
Return the rank representation of a (semi-)alphabet object.
Definition: concept.hpp:155
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 type traits for working with templates.
Provides concepts that do not have equivalents in C++20.