SeqAn3
seqan3::nucleotide_concept Interface Reference

A concept that indicates whether an alphabet represents nucleotides.In addition to the requirements for seqan3::alphabet_concept, the nucleotide_concept introduces a requirement for a complement function: seqan3::nucleotide_concept::complement. More...

#include <seqan3/alphabet/nucleotide/concept.hpp>

Inheritance diagram for seqan3::nucleotide_concept:
[legend]

Related Functions

(Note that these are not member functions.)

Requirements for seqan3::nucleotide_concept

You can expect these functions on all types that implement seqan3::nucleotide_concept.

nucleotide_type complement (nucleotide_type const alph)
 Returns the alphabet letter's complement value. More...
 
Requirements for seqan3::alphabet_concept

You can expect these functions on all types that implement seqan3::alphabet_concept.

template<typename alphabet_type >
using underlying_char_t = typename underlying_char< alphabet_type >::type
 The char_type of the alphabet. [type metafunction shortcut]. More...
 
char_type to_char (alphabet_concept const alph)
 Returns the alphabet letter's value in character representation. More...
 
alphabet_concept && assign_char (alphabet_concept &&alph, char_type const chr)
 Returns the alphabet letter's value in character representation. More...
 
Requirements for seqan3::semi_alphabet_concept

You can expect these functions on all types that implement seqan3::semi_alphabet_concept.

template<typename semi_alphabet_type >
using underlying_rank_t = typename underlying_rank< semi_alphabet_type >::type
 The rank_type of the semi_alphabet. [type metafunction shortcut]. More...
 
template<typename alphabet_type >
constexpr auto alphabet_size_v = alphabet_size<alphabet_type>::value
 The size of the alphabet. [value metafunction shortcut]. More...
 
rank_type to_rank (semi_alphabet_concept const alph)
 Returns the alphabet letter's value in rank representation. More...
 
semi_alphabet_concept && assign_rank (semi_alphabet_concept &&alph, rank_type const rank)
 Returns the alphabet letter's value in rank representation. 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...
 
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::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...
 

Detailed Description

A concept that indicates whether an alphabet represents nucleotides.

In addition to the requirements for seqan3::alphabet_concept, the nucleotide_concept introduces a requirement for a complement function: seqan3::nucleotide_concept::complement.

Concepts and doxygen
The requirements for this concept are given as related functions and metafunctions. Types that satisfy this concept are shown as "implementing this interface".

Friends And Related Function Documentation

◆ complement()

nucleotide_type complement ( nucleotide_type const  alph)
related

Returns the alphabet letter's complement value.

Parameters
alphThe alphabet letter for whom you wish to receive the complement.
Returns
The letter's complement, e.g. 'T' for 'A'.
Attention
This is a concept requirement, not an actual function (however types satisfying this concept will provide an implementation).

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