SeqAn3  3.0.2
The Modern C++ library for sequence analysis.
seqan3::writable_semialphabet Interface Reference

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

#include <seqan3/alphabet/concept.hpp>

+ Inheritance diagram for seqan3::writable_semialphabet:

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


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