writable_alphabet Interface Reference

Refines seqan3::alphabet and adds assignability. More...

#include <seqan3/alphabet/concept.hpp>

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

Refines seqan3::alphabet and adds assignability.

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

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

Requirements

1. t shall model seqan3::alphabet
2. t shall model seqan3::writable_semialphabet
3. seqan3::assign_char_to needs to be defined for objects of type t
4. seqan3::char_is_valid_for needs to be defined for type t and an argument of the character representation

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:

• seqan3/alphabet/concept.hpp