SeqAn3 3.4.0-rc.1
The Modern C++ library for sequence analysis.
Loading...
Searching...
No Matches
seqan3::dna15 Class Reference

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

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

+ Inheritance diagram for seqan3::dna15:

Public Member Functions

Constructors, destructor and assignment
constexpr dna15 () noexcept=default
 Defaulted.
 
constexpr dna15 (dna15 const &) noexcept=default
 Defaulted.
 
constexpr dna15 (dna15 &&) noexcept=default
 Defaulted.
 
constexpr dna15operator= (dna15 const &) noexcept=default
 Defaulted.
 
constexpr dna15operator= (dna15 &&) noexcept=default
 Defaulted.
 
 ~dna15 () noexcept=default
 Defaulted.
 
template<std::same_as< rna15 > t>
constexpr dna15 (t const &r) noexcept
 Allow implicit construction from seqan3::rna15 of the same size.
 
- Public Member Functions inherited from seqan3::nucleotide_base< dna15, 15 >
constexpr dna15 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_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.
 
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.
 

Related Symbols

(Note that these are not member symbols.)

using dna15_vector = std::vector< dna15 >
 Alias for a std::vector of seqan3::dna15.
 

Additional Inherited Members

- Static Public Member Functions inherited from seqan3::nucleotide_base< dna15, 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.
 
- 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 Description

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

Note that you can assign 'U' as a character to dna15 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'_dna15 or use the function seqan3::dna15::assign_char().

// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: CC0-1.0
int main()
{
using namespace seqan3::literals;
seqan3::dna15 letter{'A'_dna15};
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:160
The 15 letter DNA alphabet, containing all IUPAC smybols minus the gap.
Definition dna15.hpp:48
Provides seqan3::debug_stream and related types.
Provides seqan3::dna15, container aliases and string literals.
debug_stream_type debug_stream
A global instance of seqan3::debug_stream_type.
Definition debug_stream.hpp:37
The SeqAn namespace for literals.

This entity is stable. Since version 3.1.

Constructor & Destructor Documentation

◆ dna15()

template<std::same_as< rna15 > t>
constexpr seqan3::dna15::dna15 ( t const &  r)
inlineconstexprnoexcept

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

int main()
{
using namespace seqan3::literals;
seqan3::dna15 letter1 = 'C'_rna15; // implicitly converted
seqan3::dna15 letter2{};
letter2 = 'C'_rna15; // implicitly converted
}
Provides seqan3::rna15, container aliases and string literals.

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

#include <vector>
int main()
{
using namespace seqan3::literals;
seqan3::dna15_vector vector{'A'_rna15, 'C'_rna15, 'G'_rna15}; // (element-wise) implicit conversion
// but this won't work:
// seqan3::dna15_vector dna15_vector{"ACGT"_rna15};
// as a workaround you can use:
// side note: this would also work without the implicit conversion.
seqan3::rna15_vector rna15_vector = "ACGT"_rna15;
seqan3::dna15_vector dna15_vector{rna15_vector.begin(), rna15_vector.end()};
}
std::vector< dna15 > dna15_vector
Alias for a std::vector of seqan3::dna15.
Definition dna15.hpp:167

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

#include <vector>
int main()
{
using namespace seqan3::literals;
seqan3::dna15_vector vector = "ACG"_dna15;
auto rna15_view = vector | seqan3::views::convert<seqan3::rna15>;
for (auto && chr : rna15_view) // converts lazily on-the-fly
{
static_assert(std::same_as<decltype(chr), seqan3::rna15 &&>);
}
}
The 15 letter RNA alphabet, containing all IUPAC smybols minus the gap.
Definition rna15.hpp:48
Provides seqan3::views::convert.

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

struct my_dna15 : public seqan3::dna15
{
// using seqan3::dna15::dna15; // uncomment to import implicit conversion shown by letter1
};
struct my_rna15 : public seqan3::rna15
{};
int main()
{
using namespace seqan3::literals;
// my_dna15 letter1 = 'C'_rna15; // NO automatic implicit conversion!
// seqan3::dna15 letter2 = my_rna15{}; // seqan3::dna15 only allows implicit conversion from seqan3::rna15!
}

This entity is stable. Since version 3.1.

Friends And Related Symbol Documentation

◆ dna15_vector

using dna15_vector = std::vector<dna15>
related

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

This entity is stable. Since version 3.1.


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