SeqAn3  3.0.2
The Modern C++ library for sequence analysis.
seqan3::dna3bs Class Reference

The three letter reduced DNA alphabet for bisulfite sequencing mode (A,G,T(=C)). More...

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

+ Inheritance diagram for seqan3::dna3bs:

Public Member Functions

Constructors, destructor and assignment
constexpr dna3bs () noexcept=default
 Defaulted.
 
constexpr dna3bs (dna3bs const &) noexcept=default
 Defaulted.
 
constexpr dna3bs (dna3bs &&) noexcept=default
 Defaulted.
 
constexpr dna3bsoperator= (dna3bs const &) noexcept=default
 Defaulted.
 
constexpr dna3bsoperator= (dna3bs &&) noexcept=default
 Defaulted.
 
 ~dna3bs () noexcept=default
 Defaulted.
 
Read functions
constexpr dna3bs complement () const noexcept
 Return the complement of the letter. More...
 
Read functions
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...
 
Write functions
constexpr dna3bsassign_char (char_type const c) noexcept
 Assign from a character, implicitly converts invalid characters. More...
 
constexpr dna3bsassign_rank (rank_type const c) noexcept
 Assign from a numeric value. More...
 

Static Public Member Functions

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

static detail::min_viable_uint_t< size > constexpr alphabet_size
 The size of the alphabet, i.e. the number of different values it can take.
 

Protected Types

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()).
 

Related Functions

(Note that these are not member functions.)

using dna3bs_vector = std::vector< dna3bs >
 Alias for an std::vector of seqan3::dna3bs. More...
 
Literals
constexpr dna3bs operator""_dna3bs (char const c) noexcept
 The seqan3::dna3bs char literal. More...
 
dna3bs_vector operator""_dna3bs (char const *s, std::size_t n)
 The seqan3::dna3bs string literal. More...
 
Requirements for std::totally_ordered

You can expect these functions on all types that implement std::totally_ordered.

bool operator< (type const &lhs, type const &rhs)
 Less-than, greater-than and -or-equal comparisons. More...
 
bool operator<= (type const &lhs, type const &rhs)
 Less-than, greater-than and -or-equal comparisons. More...
 
bool operator> (type const &lhs, type const &rhs)
 Less-than, greater-than and -or-equal comparisons. More...
 
bool operator>= (type const &lhs, type const &rhs)
 Less-than, greater-than and -or-equal comparisons. More...
 
Requirements for std::equality_comparable

You can expect these functions on all types that implement std::Equality_comparable.

bool operator== (type const &lhs, type const &rhs)
 (In-)Equality comparison. More...
 
bool operator!= (type const &lhs, type const &rhs)
 (In-)Equality comparison. More...
 
Requirements for std::swappable

You can expect these functions on all types that implement std::swappable.

void swap (t &lhs, t &rhs)
 Swaps the contents of two objects. More...
 

Detailed Description

The three letter reduced DNA alphabet for bisulfite sequencing mode (A,G,T(=C)).

This alphabet represents a reduced version that can be used when dealing with bisulfite-converted data. All 'C's are converted to a 'T' in order to allow comparison of normal sequences with bisulfite-converted sequences. For completeness, this nucleotide alphabet has a complement table, however, it is not recommended to use it when dealing with bisulfite data because the complement of T is ambiguous in reads from bisulfite sequencing. A 'T' can represent a true thymidine or an unmethylated 'C' that was converted into a 'T'. Therefore, complementing a dna4bs sequence will further reduce the alphabet to only 'T' and 'A', thereby loosing all information about 'G'. When working with bisulfite data, we recommend to create the reverse complement of the dna4/5/15 range first and convert to dna3bs later. This avoids simplifying the data by automatically setting 'A' as the complement of 'C'. As an example: The sequence 'ACGTGC' in dna4 would be 'ATGTGT' in dna3bs. The complement of this dna3bs sequence would be 'TATATA', however when complementing the dna4 sequence first and afterwards transforming it into dna3bs, it would be 'TGTATG' which preserves more information from the original sequence.

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

int main()
{
using seqan3::operator""_dna3bs;
seqan3::dna3bs my_letter{'A'_dna3bs};
my_letter.assign_char('C'); // all C will be converted to T.
if (my_letter.to_char() == 'T')
seqan3::debug_stream << "yeah\n"; // "yeah";
my_letter.assign_char('F'); // unknown characters are implicitly converted to A.
if (my_letter.to_char() == 'A')
seqan3::debug_stream << "yeah\n"; // "yeah";
return 0;
}

Member Function Documentation

◆ assign_char()

constexpr dna3bs & seqan3::alphabet_base< dna3bs , size, char >::assign_char ( char_type const  c)
inlinenoexceptinherited

Assign from a character, implicitly converts invalid characters.

Parameters
cThe character to be assigned.

Provides an implementation for seqan3::assign_char_to, required to model seqan3::alphabet.

Complexity

Constant.

Exceptions

Guaranteed not to throw.

◆ assign_rank()

constexpr dna3bs & seqan3::alphabet_base< dna3bs , size, char >::assign_rank ( rank_type const  c)
inlinenoexceptinherited

Assign from a numeric value.

Parameters
cThe rank to be assigned.

Provides an implementation for seqan3::assign_rank_to, required to model seqan3::semialphabet.

Complexity

Constant.

Exceptions

Guaranteed not to throw.

◆ char_is_valid()

static constexpr bool seqan3::nucleotide_base< dna3bs , size >::char_is_valid ( char_type const  c)
inlinestaticnoexceptinherited

Validate whether a character value has a one-to-one mapping to an alphabet value.

Satisfies the seqan3::semialphabet::char_is_valid_for() requirement via the seqan3::char_is_valid_for() wrapper.

Behaviour specific to nucleotides: True also for lower case letters that silently convert to their upper case and true also for U/T respectively, e.g. 'U' is a valid character for seqan3::dna4, because its informational content is identical to 'T'.

Complexity

Constant.

Exceptions

Guaranteed not to throw.

◆ complement()

constexpr dna3bs seqan3::nucleotide_base< dna3bs , size >::complement ( ) const
inlinenoexceptinherited

Return the complement of the letter.

See Nucleotide for the actual values.

Provides an implementation for seqan3::complement, required to model seqan3::nucleotide_alphabet.

Complexity

Constant.

Exceptions

Guaranteed not to throw.

◆ to_char()

constexpr char_type seqan3::alphabet_base< dna3bs , size, char >::to_char ( ) const
inlinenoexceptinherited

Return the letter as a character of char_type.

Provides an implementation for seqan3::to_char, required to model seqan3::alphabet.

Complexity

Constant.

Exceptions

Guaranteed not to throw.

◆ to_rank()

constexpr rank_type seqan3::alphabet_base< dna3bs , size, char >::to_rank ( ) const
inlinenoexceptinherited

Return the letter's numeric value (rank in the alphabet).

Provides an implementation for seqan3::to_rank, required to model seqan3::semialphabet.

Complexity

Constant.

Exceptions

Guaranteed not to throw.

Friends And Related Function Documentation

◆ dna3bs_vector

using dna3bs_vector = std::vector<dna3bs>
related

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

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

constexpr dna3bs operator""_dna3bs ( char const  c)
related

The seqan3::dna3bs char literal.

Returns
seqan3::dna3bs

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

dna3bs_vector operator""_dna3bs ( char const *  s,
std::size_t  n 
)
related

The seqan3::dna3bs string literal.

Returns
seqan3::dna3bs_vector

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

int main()
{
using seqan3::operator""_dna3bs;
seqan3::dna3bs_vector foo{"ACGTTA"_dna3bs}; // ATGTTA
seqan3::dna3bs_vector bar = "ATGTTA"_dna3bs;
if (foo == bar)
seqan3::debug_stream << "yeah\n"; // "yeah";
auto bax = "ACGTTA"_dna3bs;
return 0;
}

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