seqan3::mask Class Reference

Implementation of a masked alphabet to be used for tuple composites. More...

#include <seqan3/alphabet/mask/mask.hpp>

Inheritance diagram for seqan3::mask:

Public Member Functions
Constructors, destructor and assignment
constexpr	mask ()=default
	Defaulted.
constexpr	mask (mask const &)=default
	Defaulted.
constexpr	mask (mask &&)=default
	Defaulted.
constexpr mask &	operator= (mask const &)=default
	Defaulted.
constexpr mask &	operator= (mask &&)=default
	Defaulted.
	~mask ()=default
	Defaulted.
Public Member Functions inherited from seqan3::alphabet_base< mask, 2, void >
constexpr	alphabet_base () noexcept=default
	Defaulted.
constexpr	alphabet_base (alphabet_base const &) noexcept=default
	Defaulted.
constexpr	alphabet_base (alphabet_base &&) noexcept=default
	Defaulted.
constexpr alphabet_base &	operator= (alphabet_base const &) noexcept=default
	Defaulted.
constexpr alphabet_base &	operator= (alphabet_base &&) noexcept=default
	Defaulted.
	~alphabet_base () noexcept=default
	Defaulted.
constexpr char_type	to_char () const noexcept
	Return the letter as a character of char_type.
constexpr rank_type	to_rank () const noexcept
	Return the letter's numeric value (rank in the alphabet).
constexpr mask &	assign_char (char_type const chr) noexcept
	Assign from a character, implicitly converts invalid characters.
constexpr mask &	assign_rank (rank_type const c) noexcept
	Assign from a numeric value.

Static Public Attributes
Boolean values
Static member "booleans" that can be assigned to the alphabet or used in aggregate initialization. Similar to an Enum interface.
static mask const	unmasked {mask{}.assign_rank(0)}
	Member for unmasked.
static mask const	masked {mask{}.assign_rank(1)}
	Member for masked.
Static Public Attributes inherited from seqan3::alphabet_base< mask, 2, void >
static constexpr detail::min_viable_uint_t< size >	alphabet_size
	The size of the alphabet, i.e. the number of different values it can take.

Private Types
using	base_t = alphabet_base< mask, 2, void >
	The base class.

Private Attributes
friend	base_t
	Befriend seqan3::alphabet_base.

Additional Inherited Members
Protected Types inherited from seqan3::alphabet_base< mask, 2, void >
using	char_type = std::conditional_t< std::same_as< void, void >, char, void >
	The char representation; conditional needed to make semi alphabet definitions legal.
using	rank_type = detail::min_viable_uint_t< size - 1 >
	The type of the alphabet when represented as a number (e.g. via to_rank()).
Related Symbols inherited from semialphabet
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.
template<cereal_input_archive archive_t, typename wrapped_alphabet_t >
void	load_minimal (archive_t const &, wrapped_alphabet_t &&l, alphabet_rank_t< detail::strip_cereal_wrapper_t< wrapped_alphabet_t > > const &r)
	Restore an alphabet letter from a saved rank.

Detailed Description

Implementation of a masked alphabet to be used for tuple composites.

This alphabet is not usually used directly, but instead via seqan3::masked.

// SPDX-FileCopyrightText: 2006-2025 Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2025 Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: CC0-1.0
 
#include <seqan3/alphabet/mask/mask.hpp>
#include <seqan3/core/debug_stream.hpp>
 
int main()
{
    seqan3::mask my_mask = seqan3::mask::masked;
    seqan3::mask another_mask{};
 
    my_mask.assign_rank(false);  // will assign my_mask the value mask::unmasked
    another_mask.assign_rank(0); // will also assign another_mask the value mask::unmasked
 
    if (my_mask.to_rank() == another_mask.to_rank())
        seqan3::debug_stream << "Both are UNMASKED!\n";
}

See also

Mask submodule , it contains an explanation of hard-masking (unknown character) and soft-masking (lower/upper case letters).

This entity is stable. Since version 3.1.

Member Data Documentation

masked

constexpr mask seqan3::mask::masked {mask{}.assign_rank(1)}

staticconstexpr

Member for masked.

This entity is stable. Since version 3.1.

unmasked

constexpr mask seqan3::mask::unmasked {mask{}.assign_rank(0)}

staticconstexpr

Member for unmasked.

This entity is stable. Since version 3.1.

---

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

• mask.hpp