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 gap &	operator= (gap const &)=default
	Defaulted.
constexpr gap &	operator= (gap &&)=default
	Defaulted.
	~gap ()=default
	Defaulted.
Read functions
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...
Write functions
constexpr gap &	assign_char (char_type const c) noexcept
	Assign from a character, implicitly converts invalid characters. More...
constexpr gap &	assign_rank (rank_type const c) noexcept
	Assign from a numeric value. More...

Static Public Attributes
static detail::min_viable_uint_t< size > constexpr	alphabet_size
	The size of the alphabet, i.e. the number of different values it can take.

Protected Types
Member types
using	char_type = std::conditional_t< std::Same< char, void >, char, char >
	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 Functions
(Note that these are not member functions.)
Requirements for std::StrictTotallyOrdered
You can expect these functions on all types that implement std::StrictTotallyOrdered.
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::EqualityComparable
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...
Requirements for std::Swappable
You can expect these functions on all types that implement std::Swappable.
void	swap (t &lhs, t &rhs)
	Swaps the contents of two objects. More...

Detailed Description

The alphabet of a gap character '-'.

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

gap my_gap = gap{};
gap another_gap{};
another_gap.assign_char('A'); // setting this does not change anything

debug_stream << my_gap.to_char(); // outputs '-'
if (my_gap.to_char() == another_gap.to_char())
    debug_stream << "Both gaps are the same!";

Member Function Documentation

assign_char()

constexpr gap & seqan3::alphabet_base< gap , size, char >::assign_char ( char_type const  c )

inlinenoexceptinherited

Assign from a character, implicitly converts invalid characters.

Parameters

c	The character to be assigned.

Provides an implementation for seqan3::assign_char_to, required to model seqan3::Alphabet.

Complexity

Constant.

Exceptions

Guaranteed not to throw.

assign_rank()

constexpr gap & seqan3::alphabet_base< gap , size, char >::assign_rank ( rank_type const  c )

inlinenoexceptinherited

Assign from a numeric value.

Parameters

c	The rank to be assigned.

Provides an implementation for seqan3::assign_rank_to, required to model seqan3::Semialphabet.

Complexity

Constant.

Exceptions

Guaranteed not to throw.

to_char()

constexpr char_type seqan3::alphabet_base< gap , size, char >::to_char ( ) const

inlinenoexceptinherited

Return the letter as a character of char_type.

Provides an implementation for seqan3::to_char, required to model seqan3::Alphabet.

Complexity

Constant.

Exceptions

Guaranteed not to throw.

to_rank()

constexpr rank_type seqan3::alphabet_base< gap , size, char >::to_rank ( ) const

inlinenoexceptinherited

Return the letter's numeric value (rank in the alphabet).

Provides an implementation for seqan3::to_rank, required to model seqan3::Semialphabet.

Complexity

Constant.

Exceptions

Guaranteed not to throw.

---

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

• seqan3/alphabet/gap/gap.hpp