seqan3::dna5 Class Reference

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

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

Inheritance diagram for seqan3::dna5:

Public Member Functions
Constructors, destructor and assignment
constexpr	dna5 () noexcept=default
	Defaulted.
constexpr	dna5 (dna5 const &) noexcept=default
	Defaulted.
constexpr	dna5 (dna5 &&) noexcept=default
	Defaulted.
constexpr dna5 &	operator= (dna5 const &) noexcept=default
	Defaulted.
constexpr dna5 &	operator= (dna5 &&) noexcept=default
	Defaulted.
	~dna5 () noexcept=default
	Defaulted.
template<std::same_as< rna5 > t>
constexpr	dna5 (t const &r) noexcept
	Allow implicit construction from seqan3::rna5 of the same size.
Public Member Functions inherited from seqan3::nucleotide_base< dna5, 5 >
constexpr dna5	complement () const noexcept
	Return the complement of the letter.
constexpr	nucleotide_base (other_nucl_type const &other) noexcept
	Allow explicit construction from any other nucleotide type and convert via the character representation.
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.
constexpr rank_type	to_rank () const noexcept
	Return the letter's numeric value (rank in the alphabet).
constexpr derived_type &	assign_char (char_type const chr) noexcept
	Assign from a character, implicitly converts invalid characters.
constexpr derived_type &	assign_rank (rank_type const c) noexcept
	Assign from a numeric value.

Private Types
using	base_t = nucleotide_base< dna5, 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.
static constexpr rank_type	rank_complement (rank_type const rank)
	Returns the complement by rank.
static constexpr char_type	rank_to_char (rank_type const rank)
	Returns the character representation of rank.

Private Attributes
friend	base_t
	Befriend seqan3::nucleotide_base.
friend	rna5
	Befriend seqan3::rna5 so it can copy char_to_rank.

Static Private Attributes
static constexpr std::array< rank_type, 256 >	char_to_rank_table
	The lookup table used in char_to_rank.
static constexpr rank_type	rank_complement_table [alphabet_size]
	The rank complement table.
static constexpr char_type	rank_to_char_table [alphabet_size] {'A', 'C', 'G', 'N', 'T'}
	The lookup table used in rank_to_char.

Related Symbols
(Note that these are not member symbols.)
using	dna5_vector = std::vector< dna5 >
	Alias for a std::vector of seqan3::dna5.
Nucleotide literals
constexpr dna5	operator""_dna5 (char const c) noexcept
	The seqan3::dna5 char literal.
constexpr dna5_vector	operator""_dna5 (char const *s, std::size_t n)
	The seqan3::dna5 string literal.
Related Symbols 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.
template<cereal_input_archive archive_t, typename wrapped_alphabet_t >
void	load_minimal (archive_t const &, wrapped_alphabet_t &&l, alphabet_rank_t< detail::strip_cereal_wrapper_t< wrapped_alphabet_t > > const &r)
	Restore an alphabet letter from a saved rank.

Additional Inherited Members
Static Public Member Functions inherited from seqan3::nucleotide_base< dna5, 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.
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.
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.
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()).

Detailed Descriptionstable-api

The five letter DNA alphabet of A,C,G,T and the unknown character N.

Note that you can assign 'U' as a character to dna5 and it will silently be converted to 'T'.

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

// SPDX-FileCopyrightText: 2006-2025 Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2025 Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: CC0-1.0
 
#include <seqan3/alphabet/nucleotide/dna5.hpp>
#include <seqan3/core/debug_stream.hpp>
 
int main()
{
    using namespace seqan3::literals;
 
    seqan3::dna5 letter{'A'_dna5};
 
    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

dna5() [stable-api]

template<std::same_as< rna5 > t>

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

stable-apiinlineconstexprnoexcept

Allow implicit construction from seqan3::rna5 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::dna5 and seqan3::rna5 are interchangeable as they behave nearly the same (e.g. same ranks, same char to rank conversion).

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

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

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

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

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

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

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

This entity is stable. Since version 3.1.

Member Function Documentation

char_to_rank() [no-api]

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

no-apiinlinestaticconstexprprivate

Returns the rank representation of character.

This function is required by seqan3::alphabet_base.

rank_complement() [no-api]

static constexpr rank_type seqan3::dna5::rank_complement ( rank_type const  rank )

no-apiinlinestaticconstexprprivate

Returns the complement by rank.

This function is required by seqan3::nucleotide_base.

rank_to_char() [no-api]

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

no-apiinlinestaticconstexprprivate

Returns the character representation of rank.

This function is required by seqan3::alphabet_base.

Friends And Related Symbol Documentation

dna5_vector [stable-api]

using dna5_vector = std::vector<dna5>

stable-apirelated

Alias for a std::vector of seqan3::dna5.

This entity is stable. Since version 3.1.

operator""_dna5() [1/2] [stable-api]

constexpr dna5_vector operator""_dna5 ( char const *  s, std::size_t  n  )

stable-apirelated

The seqan3::dna5 string literal.

Returns

seqan3::dna5_vector

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

// SPDX-FileCopyrightText: 2006-2025 Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2025 Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: CC0-1.0
 
// generated from test/snippet/alphabet/nucleotide/@target_alphabet@_literal.cpp.in
 
#include <seqan3/alphabet/nucleotide/dna5.hpp>
 
int main()
{
    using namespace seqan3::literals;
 
    seqan3::dna5_vector sequence1{"ACGTTA"_dna5};
    seqan3::dna5_vector sequence2 = "ACGTTA"_dna5;
    auto sequence3 = "ACGTTA"_dna5;
}

This entity is stable. Since version 3.1.

operator""_dna5() [2/2] [stable-api]

constexpr dna5 operator""_dna5 ( char const  c )

stable-apirelated

The seqan3::dna5 char literal.

Returns

seqan3::dna5

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

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

This entity is stable. Since version 3.1.

Member Data Documentation

char_to_rank_table [no-api]

constexpr std::array<rank_type, 256> seqan3::dna5::char_to_rank_table

no-apistaticconstexprprivate

Initial value:

{[]() constexpr
                                                                   {
                                                                       std::array<rank_type, 256> ret{};
 
                                                                       ret.fill(3u); 
 
                                                                       
                                                                       for (size_t rnk = 0u; rnk < alphabet_size; ++rnk)
                                                                       {
                                                                           ret[rank_to_char_table[rnk]] = rnk;
                                                                           ret[to_lower(rank_to_char_table[rnk])] = rnk;
                                                                       }
 
                                                                       
                                                                       ret['U'] = ret['T'];
                                                                       ret['u'] = ret['t'];
 
                                                                       
                                                                       return ret;
                                                                   }()}

The lookup table used in char_to_rank.

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

rank_complement_table [no-api]

constexpr rank_type seqan3::dna5::rank_complement_table[alphabet_size]

no-apistaticconstexprprivate

Initial value:

{
        4, 
        2, 
        1, 
        3, 
        0  
    }

The rank complement table.

rank_to_char_table [no-api]

constexpr char_type seqan3::dna5::rank_to_char_table[alphabet_size] {'A', 'C', 'G', 'N', 'T'}

no-apistaticconstexprprivate

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:

• dna5.hpp