writable_quality_alphabet Interface Reference

A concept that indicates whether a writable alphabet represents quality scores. More...

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

Inheritance diagram for writable_quality_alphabet:

Related Functions
(Note that these are not member functions.)
Generic serialisation functions for all seqan3::semialphabet
All types that satisfy seqan3::semialphabet can be serialised via Cereal.
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. More...

Detailed Description

A concept that indicates whether a writable alphabet represents quality scores.

In addition to the requirements for seqan3::writable_alphabet, the seqan3::writable_quality_alphabet introduces the requirements of seqan3::quality_alphabet.

Requirements

1. t shall model seqan3::writable_alphabet
2. t shall model seqan3::quality_alphabet
3. seqan3::assign_phred_to needs to be defined for objects of type t

See the documentation pages for the respective requirements.

Related types

If a given type t models this concept, the following types typically do so, as well:

• t &

const-qualified types on the other hand are not assignable.

Friends And Related Function Documentation

save_minimal()

template<cereal_output_archive archive_t, semialphabet alphabet_t>

alphabet_rank_t< alphabet_t > save_minimal ( archive_t const &  , alphabet_t const &  l  )

related

Save an alphabet letter to stream.

Template Parameters

archive_t	Must satisfy seqan3::cereal_output_archive.
alphabet_t	Type of l; must satisfy seqan3::semialphabet.

Parameters

l	The alphabet letter.

Delegates to seqan3::to_rank.

Attention

These functions are never called directly, see the Alphabet module on how to use serialisation.

This entity is stable. Since version 3.1.

---

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

• seqan3/alphabet/quality/concept.hpp