SeqAn3  3.0.1
The Modern C++ library for sequence analysis.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
alphabet Interface Reference

The generic alphabet concept that covers most data types used in ranges. More...

#include <seqan3/alphabet/concept.hpp>

+ Inheritance diagram for 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

The generic alphabet concept that covers most data types used in ranges.

This is the core alphabet concept that many other alphabet concepts refine.

For a detailed overview of how the different alphabet concepts are related, see Alphabet module.

Requirements

  1. t shall model seqan3::semialphabet ("has all rank representation")
  2. seqan3::to_char 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: