nucleotide_alphabet Interface Reference

A concept that indicates whether an alphabet represents nucleotides. More...

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

Inheritance diagram for nucleotide_alphabet:

Related Functions
(Note that these are not member functions.)
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...

Detailed Description

A concept that indicates whether an alphabet represents nucleotides.

In addition to the requirements for seqan3::alphabet, the nucleotide_alphabet introduces a requirement for a complement function: seqan3::nucleotide_alphabet::complement.

Requirements

1. t shall model seqan3::alphabet
2. seqan3::complement 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 &

---

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

• seqan3/alphabet/nucleotide/concept.hpp