seqan3::rna5 Class Reference

The five letter RNA alphabet of A,C,G,U and the unknown character N. More...

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

Inheritance diagram for seqan3::rna5:

Public Member Functions
Constructors, destructor and assignment
constexpr	rna5 () noexcept=default
	Defaulted.
constexpr	rna5 (rna5 const &) noexcept=default
	Defaulted.
constexpr	rna5 (rna5 &&) noexcept=default
	Defaulted.
constexpr rna5 &	operator= (rna5 const &) noexcept=default
	Defaulted.
constexpr rna5 &	operator= (rna5 &&) noexcept=default
	Defaulted.
	~rna5 () noexcept=default
	Defaulted.
constexpr	rna5 (dna5 const &r) noexcept
	Allow implicit construction from dna/rna of the same size. More...
Public Member Functions inherited from seqan3::nucleotide_base< rna5, 5 >
constexpr rna5	complement () const noexcept
	Return the complement of the letter. More...
constexpr	nucleotide_base (other_nucl_type const &other) noexcept
	Allow explicit construction from any other nucleotide type and convert via the character representation. More...
Public Member Functions inherited from seqan3::alphabet_base< derived_type, size, char_t >
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_base &	operator= (alphabet_base const &) noexcept=default
	Defaulted.
constexpr alphabet_base &	operator= (alphabet_base &&) noexcept=default
	Defaulted.
	~alphabet_base () noexcept=default
	Defaulted.
constexpr char_type	to_char () const noexcept
	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
	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...

Private Types
using	base_t = nucleotide_base< rna5, 5 >
	The base class.

Static Private Member Functions
static constexpr rank_type	char_to_rank (char_type const chr)
	Returns the rank representation of character. More...
static constexpr char_type	rank_to_char (rank_type const rank)
	Returns the character representation of rank. More...

Private Attributes
friend	base_t
	Befriend nucleotide_base.

Static Private Attributes
static const std::array< rna5, alphabet_size >	complement_table
	The complement table. More...
static constexpr char_type	rank_to_char_table [alphabet_size]
	The lookup table used in rank_to_char. More...

Related Functions
(Note that these are not member functions.)
using	rna5_vector = std::vector< rna5 >
	Alias for an std::vector of seqan3::rna5. More...
Nucleotide literals
constexpr rna5	operator""_rna5 (char const c) noexcept
	The seqan3::rna5 char literal. More...
rna5_vector	operator""_rna5 (char const *s, std::size_t n)
	The seqan3::rna5 string literal. More...
Related Functions inherited from semialphabet
template<cereal_output_archive archive_t, semialphabet alphabet_t>
alphabet_rank_t< alphabet_t >	save_minimal (archive_t const &, alphabet_t const &l)
	Save an alphabet letter to stream. More...

Additional Inherited Members
Static Public Member Functions inherited from seqan3::nucleotide_base< rna5, 5 >
static constexpr bool	char_is_valid (char_type const c) noexcept
	Validate whether a character value has a one-to-one mapping to an alphabet value. More...
Static Public Attributes inherited from seqan3::alphabet_base< derived_type, size, char_t >
static constexpr detail::min_viable_uint_t< size >	alphabet_size = 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_t >
using	char_type = std::conditional_t< std::same_as< char_t, void >, char, char_t >
	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

The five letter RNA alphabet of A,C,G,U and the unknown character N.

This alphabet has the same internal representation as seqan3::dna5, the only difference is that it prints 'U' on character conversion instead of 'T'. You can assign between values of seqan3::dna5 and seqan3::rna5.

Like most alphabets, this alphabet cannot be initialised directly from its character representation. Instead initialise/assign from the character literal or use the function seqan3::rna5::assign_char().

#include <seqan3/alphabet/nucleotide/rna5.hpp>
#include <seqan3/core/debug_stream.hpp>
int main()
{
    using namespace seqan3::literals;
 
    seqan3::rna5 letter{'A'_rna5};
 
    letter.assign_char('C');
    seqan3::debug_stream << letter << '\n'; // prints "C"
 
    letter.assign_char('F'); // Unknown characters are implicitly converted to N.
    seqan3::debug_stream << letter << '\n'; // prints "N"
}

This entity is stable. Since version 3.1.

Constructor & Destructor Documentation

rna5()

constexpr seqan3::rna5::rna5 ( dna5 const &  r )

inlineconstexprnoexcept

Allow implicit construction from dna/rna of the same size.

This entity is stable. Since version 3.1.

Member Function Documentation

char_to_rank()

static constexpr rank_type seqan3::rna5::char_to_rank ( char_type const  chr )

inlinestaticconstexprprivate

Returns the rank representation of character.

This function is required by seqan3::alphabet_base.

rank_to_char()

static constexpr char_type seqan3::rna5::rank_to_char ( rank_type const  rank )

inlinestaticconstexprprivate

Returns the character representation of rank.

This function is required by seqan3::alphabet_base.

Friends And Related Function Documentation

operator""_rna5() [1/2]

rna5_vector operator""_rna5 ( char const *  s, std::size_t  n  )

related

The seqan3::rna5 string literal.

Returns

seqan3::rna5_vector

You can use this string literal to easily assign to rna5_vector:

#include <seqan3/alphabet/nucleotide/rna5.hpp>
 
int main()
{
    using namespace seqan3::literals;
 
    seqan3::rna5_vector sequence1{"ACGTTA"_rna5};
    seqan3::rna5_vector sequence2 = "ACGTTA"_rna5;
    auto sequence3 = "ACGTTA"_rna5;
}

This entity is stable. Since version 3.1.

operator""_rna5() [2/2]

constexpr rna5 operator""_rna5 ( char const  c )

related

The seqan3::rna5 char literal.

Returns

seqan3::rna5

You can use this char literal to assign a seqan3::rna5 character:

#include <seqan3/alphabet/nucleotide/rna5.hpp>
 
int main()
{
    using namespace seqan3::literals;
 
    seqan3::rna5 letter1{'A'_rna5};
    auto letter2 = 'A'_rna5;
}

This entity is stable. Since version 3.1.

rna5_vector

using rna5_vector = std::vector<rna5>

related

Alias for an std::vector of seqan3::rna5.

This entity is stable. Since version 3.1.

Member Data Documentation

complement_table

constexpr std::array< rna5, rna5::alphabet_size > seqan3::rna5::complement_table

staticconstexprprivate

Initial value:

{
    'U'_rna5,    
    'G'_rna5,    
    'C'_rna5,    
    'N'_rna5,    
    'A'_rna5     
}

The complement table.

rank_to_char_table

constexpr char_type seqan3::rna5::rank_to_char_table[alphabet_size]

staticconstexprprivate

Initial value:

{
        'A',
        'C',
        'G',
        'N',
        'U'
    }

The lookup table used in rank_to_char.

We would have defined these lookup tables directly within their respective constexpr functions, but at the time of writing this, gcc did not (clang >= 4 did!) auto-generate lookup tables.

static constexpr char_type rank_to_char(rank_type const rank)
{
    // not possible because of static not being allowed within a constexpr function
    static constexpr lookup_table = ...;
    return lookup_table[rank];
}
 
static constexpr char_type rank_to_char(rank_type const rank)
{
    // up-to the compiler to optimise, no guarantee that a lookup table is used.
    constexpr lookup_table = ...;
    return lookup_table[rank];
}

See also

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=99320 for the progress on gcc

---

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

• seqan3/alphabet/nucleotide/rna5.hpp