A CRTP-base that eases the definition of proxy types returned in place of regular alphabets. More...
#include <seqan3/alphabet/detail/alphabet_proxy.hpp>
Public Types | |
Member types | |
using | rank_type = alphabet_rank_t< alphabet_type > |
The type of the rank representation. | |
Public Member Functions | |
Write functions | |
All of these call the emulated type's write functions and then delegate to the assignment operator which invokes derived behaviour. | |
constexpr derived_type & | assign_rank (alphabet_rank_t< alphabet_type > const r) noexcept |
constexpr derived_type & | assign_char (char_type const c) noexcept requires WritableAlphabet< alphabet_type > |
constexpr derived_type & | assign_phred (phred_type const c) noexcept requires WritableQualityAlphabet< alphabet_type > |
Read functions | |
constexpr | operator alphabet_type () const noexcept |
Implicit conversion to the emulated type. | |
constexpr auto | to_char () const noexcept requires Alphabet< alphabet_type > |
constexpr auto | to_phred () const noexcept requires QualityAlphabet< alphabet_type > |
static constexpr bool | char_is_valid (char_type const c) noexcept requires WritableAlphabet< alphabet_type > |
Delegate to the emulated type's validator. | |
A CRTP-base that eases the definition of proxy types returned in place of regular alphabets.
derived_type | The CRTP parameter type. |
alphabet_type | The type of the alphabet that this proxy emulates. |
Certain containers and other data structure hold alphabet values in a non-standard way so they can convert to that alphabet when being accessed, but cannot return a reference to the held value. These data structures may instead return a proxy to the held value which still allows changing it (and updating the underlying data structure to reflect this).
This CRTP base facilitates the definition of such proxies. Most users of SeqAn will not need to understand the details.
This class ensures that the proxy itself also models seqan3::Semialphabet, seqan3::Alphabet, seqan3::QualityAlphabet, seqan3::NucleotideAlphabet and/or seqan3::AminoacidAlphabet if the emulated type models these. This makes sure that function templates which accept the original, also accept the proxy. An exception are multi-layered composites of alphabets where the proxy currently does not support access via get
.
The derived type needs to provide an .on_update()
member function that performs the changes in the underlying data structure.
See seqan3::bitcompressed_vector or seqan3::alphabet_tuple_base for examples of how this class is used.