SeqAn3  3.0.3
The Modern C++ library for sequence analysis.
writable_semialphabet Interface Reference

A refinement of seqan3::semialphabet that adds assignability. More...

#include <seqan3/alphabet/concept.hpp>

+ Inheritance diagram for writable_semialphabet:

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 refinement of seqan3::semialphabet that adds assignability.

This concept refines seqan3::semialphabet and adds the requirement to be able to change the value by assigning a value of the rank representation.

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

Requirements

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

Serialisation

Types that model the concept (and all refinements) can be serialised via SeqAn serialisation support. The rank value is (de-)serialised, types need not provide any overloads themselves.

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_tMust satisfy seqan3::cereal_output_archive.
alphabet_tType of l; must satisfy seqan3::semialphabet.
Parameters
lThe 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: