aminoacid_alphabet Interface Reference

A concept that indicates whether an alphabet represents amino acids. More...

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

Inheritance diagram for aminoacid_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 an alphabet represents amino acids.

Since an amino acid alphabet has no specific characteristics (like the complement function for nucleotide alphabets), we distinguish an amino acid alphabet by the seqan3::is_aminoacid type trait.

Concepts and doxygen

The requirements for this concept are given as related functions and type traits. Types that satisfy this concept are shown as "implementing this interface".

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