SeqAn3  3.2.0
The Modern C++ library for sequence analysis.
seqan3::nucleotide_base< derived_type, size > Class Template Reference

A CRTP-base that refines seqan3::alphabet_base and is used by the nucleotides. More...

#include <seqan3/alphabet/nucleotide/nucleotide_base.hpp>

+ Inheritance diagram for seqan3::nucleotide_base< derived_type, size >:

Additional Inherited Members

- Public Member Functions inherited from seqan3::alphabet_base< derived_type, size, char >
constexpr alphabet_base () noexcept=default
 Defaulted.
 
constexpr alphabet_base (alphabet_base const &) noexcept=default
 Defaulted.
 
constexpr alphabet_base (alphabet_base &&) noexcept=default
 Defaulted.
 
constexpr alphabet_baseoperator= (alphabet_base const &) noexcept=default
 Defaulted.
 
constexpr alphabet_baseoperator= (alphabet_base &&) noexcept=default
 Defaulted.
 
 ~alphabet_base () noexcept=default
 Defaulted.
 
constexpr char_type to_char () const noexcept requires(!std
 Return the letter as a character of char_type. More...
 
constexpr rank_type to_rank () const noexcept
 Return the letter's numeric value (rank in the alphabet). More...
 
constexpr derived_type & assign_char (char_type const chr) noexcept requires(!std
 Assign from a character, implicitly converts invalid characters. More...
 
constexpr derived_type & assign_rank (rank_type const c) noexcept
 Assign from a numeric value. More...
 
- Static Public Attributes inherited from seqan3::alphabet_base< derived_type, size, char >
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. More...
 
- Protected Types inherited from seqan3::alphabet_base< derived_type, size, char >
using char_type = std::conditional_t< std::same_as< char, void >, char, char >
 The char representation; conditional needed to make semi alphabet definitions legal. More...
 
using rank_type = detail::min_viable_uint_t< size - 1 >
 The type of the alphabet when represented as a number (e.g. via to_rank()). More...
 

Detailed Description

template<typename derived_type, auto size>
class seqan3::nucleotide_base< derived_type, size >

A CRTP-base that refines seqan3::alphabet_base and is used by the nucleotides.

Template Parameters
derived_typeThe CRTP parameter type.
sizeThe size of the alphabet.

You can use this class to define your own nucleotide alphabet, but types are not required to be based on it to model seqan3::nucleotide_alphabet, it is purely a way to avoid code duplication.

In addition to the requirements of seqan3::alphabet_base, the derived type needs to define the following static member variable (can be private):

  • static std::array<THAT_TYPE, alphabet_size> complement_table that defines for every possible rank value the corresponding complement.

This entity is stable. Since version 3.1.


The documentation for this class was generated from the following file: