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

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 &

This entity is stable. Since version 3.1.

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/concept.hpp