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

Representation of a vertex in the Union-Find data structure containing a data. More...

#include <Union_find.hpp>

Public Types

typedef T_Union_find_vertex_data_structure_contains< T > Self
 
typedef Union_find_vertex_data_structure_base Base
 
typedef std::size_t UF_index_type
 Index type representing a vertex in the Union-Find data structure. More...
 

Constructors

 T_Union_find_vertex_data_structure_contains (void)
 Constructs a default vertex with an empty attached data. More...
 
 T_Union_find_vertex_data_structure_contains (T data)
 Constructs a default vertex with an attached data. More...
 

Accessors

const T data (void) const
 Const access to the attached data. More...
 
data (void)
 Access to the attached data. More...
 

Accessors

bool is_valid_union_find_index (void) const
 check that the index of the vertex has been initialized More...
 
UF_index_type get_union_find_index (void) const
 Access to the Union-Find index. More...
 

Detailed Description

template<class T>
class SBL::CADS::T_Union_find_vertex_data_structure_contains< T >

Representation of a vertex in the Union-Find data structure containing a data.

A copy of the data is created in the vertex. It is possible to use a reference or a pointer type for copying the reference or the pointer instead of the data itself.

Template Parameters
TType of data. The type has to be default and copy constructible.

Member Typedef Documentation

◆ Base

◆ Self

◆ UF_index_type

typedef std::size_t UF_index_type
inherited

Index type representing a vertex in the Union-Find data structure.

Constructor & Destructor Documentation

◆ T_Union_find_vertex_data_structure_contains() [1/2]

Constructs a default vertex with an empty attached data.

◆ T_Union_find_vertex_data_structure_contains() [2/2]

Constructs a default vertex with an attached data.

Member Function Documentation

◆ data() [1/2]

T data ( void  )
inline

Access to the attached data.

◆ data() [2/2]

const T data ( void  ) const
inline

Const access to the attached data.

◆ get_union_find_index()

Union_find_vertex_data_structure_base::UF_index_type get_union_find_index ( void  ) const
inlineinherited

Access to the Union-Find index.

Precondition
The index is valid.

◆ is_valid_union_find_index()

bool is_valid_union_find_index ( void  ) const
inlineinherited

check that the index of the vertex has been initialized