Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
T_IG_label_traits< Dummy > Class Template Reference

[definition] More...

#include <IG_label_traits.hpp>

Classes

class  Primitive_label_classifier
 Functor returning a pair classifying a particle. More...
 

Public Types

enum  Label { L_LABEL = 1 , H_LABEL = 2 , IG_LABEL = 3 }
 Enumerate the hierarchical labels in IG. More...
 
typedef T_IG_label_traits< Dummy > Self
 

Static Public Member Functions

static unsigned get_number_of_labels (void)
 Count the number of labels, that is always 3. More...
 
static unsigned get_number_of_primitive_labels (void)
 Count the number of primitive labels, that is always 4. More...
 
static Label get_parent_of (Label label)
 IG is the only root of the hierarchy, and H1, L1, H2, L2 are the leaves of the hierarchy.
More...
 
static std::string to_string (Label label)
 Return a string representing the label. More...
 

Detailed Description

template<class Dummy = void>
class SBL::Models::T_IG_label_traits< Dummy >

[definition]

Member Typedef Documentation

◆ Self

typedef T_IG_label_traits<Dummy> Self

Member Enumeration Documentation

◆ Label

enum Label

Enumerate the hierarchical labels in IG.

Enumerator
L_LABEL 
H_LABEL 
IG_LABEL 

Member Function Documentation

◆ get_number_of_labels()

static unsigned get_number_of_labels ( void  )
inlinestatic

Count the number of labels, that is always 3.

◆ get_number_of_primitive_labels()

static unsigned get_number_of_primitive_labels ( void  )
inlinestatic

Count the number of primitive labels, that is always 4.

◆ get_parent_of()

static Label get_parent_of ( Label  label)
inlinestatic

IG is the only root of the hierarchy, and H1, L1, H2, L2 are the leaves of the hierarchy.

◆ to_string()

static std::string to_string ( Label  label)
inlinestatic

Return a string representing the label.