SeqAn3  3.0.2
The Modern C++ library for sequence analysis.
seqan3::qualified< sequence_alphabet_t, quality_alphabet_t > Class Template Reference

Joins an arbitrary alphabet with a quality alphabet. More...

#include <seqan3/alphabet/quality/qualified.hpp>

+ Inheritance diagram for seqan3::qualified< sequence_alphabet_t, quality_alphabet_t >:

Public Types

using char_type = alphabet_char_t< sequence_alphabet_type >
 Equals the char_type of sequence_alphabet_type.
 
using phred_type = alphabet_phred_t< quality_alphabet_type >
 Equals the phred_type of the quality_alphabet_type.
 
using quality_alphabet_type = quality_alphabet_t
 Second template parameter as member type.
 
using sequence_alphabet_type = sequence_alphabet_t
 First template parameter as member type.
 

Public Member Functions

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 qualified< sequence_alphabet_t, quality_alphabet_t > & assign_char (char_type const c) noexcept
 Assign from a character, implicitly converts invalid characters. More...
 
constexpr qualified< sequence_alphabet_t, quality_alphabet_t > & assign_rank (rank_type const c) noexcept
 Assign from a numeric value. 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 qualified< sequence_alphabet_t, quality_alphabet_t > & assign_char (char_type const c) noexcept
 Assign from a character, implicitly converts invalid characters. More...
 
constexpr qualified< sequence_alphabet_t, quality_alphabet_t > & assign_rank (rank_type const c) noexcept
 Assign from a numeric value. More...
 
Constructors, destructor and assignment
constexpr qualified () noexcept=default
 Defaulted.
 
constexpr qualified (qualified const &) noexcept=default
 Defaulted.
 
constexpr qualified (qualified &&) noexcept=default
 Defaulted.
 
constexpr qualifiedoperator= (qualified const &) noexcept=default
 Defaulted.
 
constexpr qualifiedoperator= (qualified &&) noexcept=default
 Defaulted.
 
 ~qualified () noexcept=default
 Defaulted.
 
constexpr qualified (component_type const alph) noexcept
 Construction via a value of one of the components. More...
 
constexpr qualified (indirect_component_type const alph) noexcept
 Construction via a value of a subtype that is assignable to one of the components. More...
 
constexpr qualifiedoperator= (component_type const alph) noexcept
 Assignment via a value of one of the components. More...
 
constexpr qualifiedoperator= (indirect_component_type const alph) noexcept
 Assignment via a value of a subtype that is assignable to one of the components. More...
 
Write functions
constexpr qualifiedassign_char (char_type const c) noexcept
 Assign from a character. This modifies the internal sequence letter.
 
constexpr qualifiedassign_phred (phred_type const c) noexcept
 Assign from a phred value. This modifies the internal quality letter.
 
Read functions
constexpr phred_type to_phred () const noexcept
 Return the phred value. This reads the internal quality letter.
 
constexpr char_type to_char () const noexcept
 Return a character. This reads the internal sequence letter.
 
constexpr qualified complement () const noexcept requires nucleotide_alphabet< sequence_alphabet_t >
 Return a qualified where the quality is preserved, but the sequence letter is complemented. More...
 
Read functions

All read operations are constant complexity.

constexpr operator type () const noexcept
 Implicit cast to a single letter. Works only if the type is unique in the type list.
 
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 qualified< sequence_alphabet_t, quality_alphabet_t > & assign_char (char_type const c) noexcept
 Assign from a character, implicitly converts invalid characters. More...
 
constexpr qualified< sequence_alphabet_t, quality_alphabet_t > & assign_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 is valid in the sequence alphabet.
 

Static Public Attributes

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.
 

Protected Types

Member types
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.)

template<typename sequence_alphabet_type , typename quality_alphabet_type >
 qualified (sequence_alphabet_type &&, quality_alphabet_type &&) -> qualified< std::decay_t< sequence_alphabet_type >, std::decay_t< quality_alphabet_type >>
 Type deduction guide enables usage of qualified without specifying template args.
 

Detailed Description

template<writable_alphabet sequence_alphabet_t, writable_quality_alphabet quality_alphabet_t>
class seqan3::qualified< sequence_alphabet_t, quality_alphabet_t >

Joins an arbitrary alphabet with a quality alphabet.

Template Parameters
sequence_alphabet_tType of the alphabet; must satisfy seqan3::writable_alphabet.
quality_alphabet_tType of the quality; must satisfy seqan3::writable_quality_alphabet.

This composite pairs an arbitrary alphabet with a quality alphabet, where each alphabet character is stored together with its quality score in a single value. That way, you can can conveniently access the character and score information at each position of the qualified-sequence. The use case that this was designed for is a nucleotide sequence with corresponding quality scores, e.g. obtained when reading in a FASTQ file of Illumina reads. The composite also allows to store quality scores for different or extended alphabets like a qualified<char, phred42> or a qualified<gapped<dna4>, phred42> sequence. The rank values correspond to numeric values in the size of the composite, while the character values are taken from the sequence alphabet and the phred values are taken from the quality alphabet.

As with all seqan3::alphabet_tuple_base s you may access the individual alphabet letters in regular c++ tuple notation, i.e. get<0>(t) and objects can be brace-initialised with the individual members.

int main()
{
using seqan3::operator""_dna4;
using seqan3::get;
seqan3::debug_stream << int(seqan3::to_rank(letter)) << ' '
<< int(seqan3::to_rank(get<0>(letter))) << ' '
<< int(seqan3::to_rank(get<1>(letter))) << '\n';
// 28 0 7
<< seqan3::to_char(get<0>(letter)) << ' '
<< seqan3::to_char(get<1>(letter)) << '\n';
// A A (
<< seqan3::to_phred(get<1>(letter)) << '\n';
// 7 7
// modify via structured bindings and references:
auto & [ seq_l, qual_l ] = letter;
seq_l = 'G'_dna4;
// G
}

This seqan3::alphabet_tuple_base itself fulfils both seqan3::writable_alphabet and seqan3::writable_quality_alphabet.

Constructor & Destructor Documentation

◆ qualified() [1/2]

template<writable_alphabet sequence_alphabet_t, writable_quality_alphabet quality_alphabet_t>
constexpr seqan3::qualified< sequence_alphabet_t, quality_alphabet_t >::qualified ( component_type const  alph)
inlineconstexprnoexcept

Construction via a value of one of the components.

Template Parameters
component_typeMust be one uniquely contained in the type list of the composite.
Parameters
alphThe value of a component that should be assigned.

Note: Since the alphabet_tuple_base is a CRTP base class, we show the working examples with one of its derived classes (seqan3::qualified).

int main()
{
using seqan3::operator""_dna4;
// creates {'C'_dna4, seqan3::phred42{0}}
// creates {'A'_dna4, seqan3::phred42{1}}
if (letter1 == letter2)
seqan3::debug_stream << "yeah\n"; // yeah
}

◆ qualified() [2/2]

template<writable_alphabet sequence_alphabet_t, writable_quality_alphabet quality_alphabet_t>
constexpr seqan3::qualified< sequence_alphabet_t, quality_alphabet_t >::qualified ( indirect_component_type const  alph)
inlineconstexprnoexcept

Construction via a value of a subtype that is assignable to one of the components.

Template Parameters
indirect_component_typeType that models seqan3::weakly_assignable_from for one of the component types.
Parameters
alphThe value that should be assigned.

Note that the value will be assigned to the FIRST type T that fulfils assignable_from<T, indirect_component_type>, regardless if other types are also fit for assignment.

Note: Since the alphabet_tuple_base is a CRTP base class, we show the working examples with one of its derived classes (seqan3::qualified).

int main()
{
using seqan3::operator""_dna4;
using seqan3::operator""_rna4;
// The following creates {'C'_dna4, phred42{0}}
// The following also creates {'C'_dna4, seqan3::phred42{0}}, since rna4 assignable to dna4
if (letter1 == letter2)
seqan3::debug_stream << "yeah\n"; // yeah
}

Member Function Documentation

◆ assign_char()

constexpr qualified< sequence_alphabet_t, quality_alphabet_t > & seqan3::alphabet_base< qualified< sequence_alphabet_t, quality_alphabet_t > , size, void >::assign_char ( char_type const  c)
inlineconstexprnoexceptinherited

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 qualified< sequence_alphabet_t, quality_alphabet_t > & seqan3::alphabet_base< qualified< sequence_alphabet_t, quality_alphabet_t > , size, void >::assign_rank ( rank_type const  c)
inlineconstexprnoexceptinherited

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.

◆ complement()

template<writable_alphabet sequence_alphabet_t, writable_quality_alphabet quality_alphabet_t>
constexpr qualified seqan3::qualified< sequence_alphabet_t, quality_alphabet_t >::complement ( ) const
inlineconstexprnoexcept

Return a qualified where the quality is preserved, but the sequence letter is complemented.

See also
seqan3::complement
seqan3::nucleotide_alphabet::complement

◆ operator=() [1/2]

template<writable_alphabet sequence_alphabet_t, writable_quality_alphabet quality_alphabet_t>
constexpr qualified& seqan3::qualified< sequence_alphabet_t, quality_alphabet_t >::operator= ( component_type const  alph)
inlineconstexprnoexcept

Assignment via a value of one of the components.

Template Parameters
component_typeOne of the component types. Must be uniquely contained in the type list of the composite.
Parameters
alphThe value of a component that should be assigned.

Note: Since the alphabet_tuple_base is a CRTP base class, we show the working examples with one of its derived classes (seqan3::qualified).

int main()
{
using seqan3::operator""_dna4;
letter1 = 'C'_dna4; // yields {'C'_dna4, seqan3::phred42{1}}
letter1 = seqan3::phred42{2}; // yields {'C'_dna4, seqan3::phred42{2}}
}

◆ operator=() [2/2]

template<writable_alphabet sequence_alphabet_t, writable_quality_alphabet quality_alphabet_t>
constexpr qualified& seqan3::qualified< sequence_alphabet_t, quality_alphabet_t >::operator= ( indirect_component_type const  alph)
inlineconstexprnoexcept

Assignment via a value of a subtype that is assignable to one of the components.

Template Parameters
indirect_component_typeType that models seqan3::weakly_assignable_from for one of the component types.
Parameters
alphThe value of a component that should be assigned.

Note: Since the alphabet_tuple_base is a CRTP base class, we show the working examples with one of its derived classes (seqan3::qualified).

int main()
{
using seqan3::operator""_dna4;
using seqan3::operator""_rna4;
letter1 = 'C'_rna4; // yields {'C'_dna4, seqan3::phred42{1}}
}

◆ to_char()

constexpr char_type seqan3::alphabet_base< qualified< sequence_alphabet_t, quality_alphabet_t > , size, void >::to_char
inlineconstexprnoexceptinherited

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< qualified< sequence_alphabet_t, quality_alphabet_t > , size, void >::to_rank
inlineconstexprnoexceptinherited

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.


The documentation for this class was generated from the following file:
debug_stream.hpp
Provides seqan3::debug_stream and related types.
qualified.hpp
Provides quality alphabet composites.
dna4.hpp
Provides seqan3::dna4, container aliases and string literals.
seqan3::to_char
constexpr auto to_char
Return the char representation of an alphabet object.
Definition: concept.hpp:321
seqan3::to_rank
constexpr auto to_rank
Return the rank representation of a (semi-)alphabet object.
Definition: concept.hpp:143
all.hpp
Meta-header for the nucleotide submodule; includes all headers from alphabet/nucleotide/.
seqan3::phred42
Quality type for traditional Sanger and modern Illumina Phred scores (typical range).
Definition: phred42.hpp:43
seqan3::to_phred
constexpr auto to_phred
The public getter function for the phred representation of a quality score.
Definition: concept.hpp:89
seqan3::qualified
Joins an arbitrary alphabet with a quality alphabet.
Definition: qualified.hpp:56
seqan3::debug_stream
debug_stream_type debug_stream
A global instance of seqan3::debug_stream_type.
Definition: debug_stream.hpp:42
phred42.hpp
Provides seqan3::phred42 quality scores.
seqan3::get
constexpr const auto & get(configuration< configs_t... > const &config) noexcept
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: configuration.hpp:627