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.

template<std::same_as< dna5 > t>
constexpr	rna5 (t const &r) noexcept
	Allow implicit construction from seqan3::dna5 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< rna5, 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_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 rna5 &	assign_char (char_type const chr) noexcept
	Assign from a character, implicitly converts invalid characters. More...

constexpr rna5 &	assign_rank (rank_type const c) noexcept
	Assign from a numeric value. More...

Related Functions
(Note that these are not member functions.)
using	rna5_vector = std::vector< rna5 >
	Alias for a 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...

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< rna5, 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< rna5, 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

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 'A'_rna5 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()

template<std::same_as< dna5 > t>

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

inlineconstexprnoexcept

Allow implicit construction from seqan3::dna5 of the same size.

Normally, we do not allow implicit conversion of single argument constructors, but in this case we make an exception, because seqan3::rna5 and seqan3::dna5 are interchangeable as they behave nearly the same (e.g. same ranks, same char to rank conversion).

#include <seqan3/alphabet/nucleotide/rna5.hpp>
#include <seqan3/alphabet/nucleotide/dna5.hpp>
 
int main()
{
    using namespace seqan3::literals;
 
    seqan3::rna5 letter1 = 'C'_dna5; // implicitly converted
    seqan3::rna5 letter2{};
    letter2 = 'C'_dna5; // implicitly converted
}

seqan3::sequences (e.g. seqan3::rna5_vector) in general are not implicitly convertible and must be explicitly copied to be converted:

#include <vector>
 
#include <seqan3/alphabet/nucleotide/rna5.hpp>
#include <seqan3/alphabet/nucleotide/dna5.hpp>
 
int main()
{
    using namespace seqan3::literals;
 
    seqan3::rna5_vector vector{'A'_dna5, 'C'_dna5, 'G'_dna5}; // (element-wise) implicit conversion
 
    // but this won't work:
    // seqan3::rna5_vector rna5_vector{"ACGT"_dna5};
 
    // as a workaround you can use:
    // side note: this would also work without the implicit conversion.
    seqan3::dna5_vector dna5_vector = "ACGT"_dna5;
    seqan3::rna5_vector rna5_vector{dna5_vector.begin(), dna5_vector.end()};
}

You can avoid this copy by using std::ranges::views:

#include <vector>
 
#include <seqan3/alphabet/nucleotide/rna5.hpp>
#include <seqan3/alphabet/nucleotide/dna5.hpp>
#include <seqan3/utility/views/convert.hpp>
 
int main()
{
    using namespace seqan3::literals;
 
    seqan3::rna5_vector vector = "ACG"_rna5;
 
    auto dna5_view = vector | seqan3::views::convert<seqan3::dna5>;
 
    for (auto && chr: dna5_view) // converts lazily on-the-fly
    {
        static_assert(std::same_as<decltype(chr), seqan3::dna5 &&>);
    }
}

This conversion constructor only allows converting seqan3::dna5 to seqan3::rna5. Other alphabets that inherit from seqan3::dna5 will not be implicitly convertible to seqan3::rna5.

#include <seqan3/alphabet/nucleotide/rna5.hpp>
#include <seqan3/alphabet/nucleotide/dna5.hpp>
 
struct my_rna5 : public seqan3::rna5
{
    // using seqan3::rna5::rna5; // uncomment to import implicit conversion shown by letter1
};
 
struct my_dna5 : public seqan3::dna5
{};
 
int main()
{
    using namespace seqan3::literals;
 
    // my_rna5 letter1 = 'C'_dna5; // NO automatic implicit conversion!
    // seqan3::rna5 letter2 = my_dna5{}; // seqan3::rna5 only allows implicit conversion from seqan3::dna5!
}

This entity is stable. Since version 3.1.

Friends And Related Function Documentation

◆ operator""_rna5() [1/2]

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

Returns: seqan3::rna5_vector

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

// generated from test/snippet/alphabet/nucleotide/@target_alphabet@_literal.cpp.in
 
#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 )

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>

This entity is stable. Since version 3.1.

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

rna5.hpp

Public Member Functions

Related Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ rna5()

Friends And Related Function Documentation

◆ operator""_rna5() [1/2]

◆ operator""_rna5() [2/2]

◆ rna5_vector