seqan3::QualityAlphabet Interface Reference

A concept that indicates whether an alphabet represents quality scores. More...

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

Inheritance diagram for seqan3::QualityAlphabet:

Related Functions
(Note that these are not member functions.)
Requirements for std::StrictTotallyOrdered
You can expect these functions on all types that implement std::StrictTotallyOrdered.
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::EqualityComparable
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...

Detailed Description

A concept that indicates whether an alphabet represents quality scores.

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

In addition to the requirements for seqan3::Alphabet, the QualityAlphabet introduces a requirement for conversion functions from and to a Phred score.

Concepts and doxygen

Requirements

1. t shall model seqan3::Alphabet
2. seqan3::to_phred 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 &
• t const
• t const &

In addition to the requirements for seqan3::WritableAlphabet, the seqan3::WritableQualityAlphabet introduces the requirements of seqan3::QualityAlphabet.

Requirements

1. t shall model seqan3::WritableAlphabet
2. t shall model seqan3::QualityAlphabet
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.

---

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

• seqan3/alphabet/quality/concept.hpp