SeqAn3  3.0.3
The Modern C++ library for sequence analysis.
seqan3::rna15 Class Reference

The 15 letter RNA alphabet, containing all IUPAC smybols minus the gap. More...

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

+ Inheritance diagram for seqan3::rna15:

Public Member Functions

Constructors, destructor and assignment
constexpr rna15 () noexcept=default
 Defaulted.
 
constexpr rna15 (rna15 const &) noexcept=default
 Defaulted.
 
constexpr rna15 (rna15 &&) noexcept=default
 Defaulted.
 
constexpr rna15operator= (rna15 const &) noexcept=default
 Defaulted.
 
constexpr rna15operator= (rna15 &&) noexcept=default
 Defaulted.
 
 ~rna15 () noexcept=default
 Defaulted.
 
constexpr rna15 (dna15 const &r) noexcept
 Allow implicit construction from dna/rna of the same size. More...
 
- Public Member Functions inherited from seqan3::nucleotide_base< rna15, 15 >
constexpr nucleotide_base (other_nucl_type const &other) noexcept
 Allow explicit construction from any other nucleotide type and convert via the character representation. More...
 
constexpr rna15 complement () const noexcept
 Return the complement of the letter. 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_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
 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...
 

Related Functions

(Note that these are not member functions.)

using rna15_vector = std::vector< rna15 >
 Alias for an std::vector of seqan3::rna15. More...
 
Nucleotide literals
constexpr rna15 operator""_rna15 (char const c) noexcept
 The seqan3::rna15 char literal. More...
 
rna15_vector operator""_rna15 (char const *s, std::size_t n)
 The seqan3::rna15 string literal. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from seqan3::nucleotide_base< rna15, 15 >
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 15 letter RNA alphabet, containing all IUPAC smybols minus the gap.

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

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::rna15::assign_char().

int main()
{
using namespace seqan3::literals;
seqan3::rna15 letter{'A'_rna15};
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"
}
constexpr derived_type & assign_char(char_type const chr) noexcept
Assign from a character, implicitly converts invalid characters.
Definition: alphabet_base.hpp:211
The 15 letter RNA alphabet, containing all IUPAC smybols minus the gap.
Definition: rna15.hpp:51
Provides seqan3::debug_stream and related types.
debug_stream_type debug_stream
A global instance of seqan3::debug_stream_type.
Definition: debug_stream.hpp:42
The SeqAn namespace for literals.
Provides seqan3::rna15, container aliases and string literals.

This entity is stable. Since version 3.1.

Constructor & Destructor Documentation

◆ rna15()

constexpr seqan3::rna15::rna15 ( dna15 const &  r)
inlineconstexprnoexcept

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

This entity is stable. Since version 3.1.

Friends And Related Function Documentation

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

rna15_vector operator""_rna15 ( char const *  s,
std::size_t  n 
)
related

The seqan3::rna15 string literal.

Returns
seqan3::rna15_vector

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

int main()
{
using namespace seqan3::literals;
seqan3::rna15_vector sequence1{"ACGTTA"_rna15};
seqan3::rna15_vector sequence2 = "ACGTTA"_rna15;
auto sequence3 = "ACGTTA"_rna15;
}

This entity is stable. Since version 3.1.

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

constexpr rna15 operator""_rna15 ( char const  c)
related

The seqan3::rna15 char literal.

Returns
seqan3::rna15

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

int main()
{
using namespace seqan3::literals;
seqan3::rna15 letter1{'A'_rna15};
auto letter2 = 'A'_rna15;
}

This entity is stable. Since version 3.1.

◆ rna15_vector

using rna15_vector = std::vector<rna15>
related

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

This entity is stable. Since version 3.1.


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