SeqAn3  3.0.3
The Modern C++ library for sequence analysis.
seqan3::gap Class Reference

The alphabet of a gap character '-'. More...

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

+ Inheritance diagram for seqan3::gap:

Public Member Functions

Constructors, destructor and assignment
constexpr gap () noexcept
 Defaulted.
 
constexpr gap (gap const &)=default
 Defaulted.
 
constexpr gap (gap &&)=default
 Defaulted.
 
constexpr gapoperator= (gap const &)=default
 Defaulted.
 
constexpr gapoperator= (gap &&)=default
 Defaulted.
 
 ~gap ()=default
 Defaulted.
 
- Public Member Functions inherited from seqan3::alphabet_base< gap, 1, char >
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_baseoperator= (alphabet_base const &) noexcept=default
 Defaulted.
 
constexpr alphabet_baseoperator= (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. More...
 
constexpr rank_type to_rank () const noexcept
 Return the letter's numeric value (rank in the alphabet). More...
 
constexpr gapassign_char (char_type const chr) noexcept
 Assign from a character, implicitly converts invalid characters. More...
 
constexpr gapassign_rank (rank_type const c) noexcept
 Assign from a numeric value. More...
 

Additional Inherited Members

- Static Public Attributes inherited from seqan3::alphabet_base< gap, 1, char >
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. More...
 
- Protected Types inherited from seqan3::alphabet_base< gap, 1, char >
using char_type = std::conditional_t< std::same_as< char, void >, char, char >
 The char representation; conditional needed to make semi alphabet definitions legal. More...
 
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()). More...
 

Detailed Description

The alphabet of a gap character '-'.

The alphabet always has the same value ('-').

#include <iostream>
int main()
{
seqan3::gap another_gap{};
another_gap.assign_char('A'); // this does not change anything
seqan3::debug_stream << my_gap.to_char(); // outputs '-'
if (my_gap.to_char() == another_gap.to_char())
seqan3::debug_stream << "Both gaps are the same!";
}
constexpr char_type to_char() const noexcept
Return the letter as a character of char_type.
Definition: alphabet_base.hpp:139
constexpr derived_type & assign_char(char_type const chr) noexcept
Assign from a character, implicitly converts invalid characters.
Definition: alphabet_base.hpp:211
The alphabet of a gap character '-'.
Definition: gap.hpp:39
Provides seqan3::debug_stream and related types.
Provides seqan3::gap.
debug_stream_type debug_stream
A global instance of seqan3::debug_stream_type.
Definition: debug_stream.hpp:42

This entity is stable. Since version 3.1.


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