SeqAn3
seqan3::max_pseudoknot_depth< alphabet_type > Struct Template Reference

Metafunction that indicates to what extent an alphabet can handle pseudoknots. [value metafunction base template]. More...

#include <seqan3/alphabet/concept_pre.hpp>

Detailed Description

template<typename alphabet_type>
struct seqan3::max_pseudoknot_depth< alphabet_type >

Metafunction that indicates to what extent an alphabet can handle pseudoknots. [value metafunction base template].

Template Parameters
alphabet_typeThe alphabet type whose pseudoknot ability is queried.

The value is the maximum allowed depth of pseudoknots. A value of 1 denotes no pseudoknots ((....)), while higher values denote the maximum allowed complexity of crossing interactions, e.g. depth 2 (({....))} or depth 3 ({[....)}].

This is the expression to retrieve the value:

using alphabet_type = structured_rna<rna4, dot_bracket3>;
// or
uint8_t pk_support_2 = seqan3::max_pseudoknot_depth_v<alphabet_type>;
Helper variable template
seqan3::max_pseudoknot_depth_v as a shorthand for seqan3::max_pseudoknot_depth<alphabet_type>::value
Attention
This is the base template, it needs to be specialised.

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