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

Representation of a vertex of the Union-Find data structure inheriting a data type. More...

#include <Union_find.hpp>

Public Types

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_specializes (void)
 Constructs a default vertex. 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_specializes< T >

Representation of a vertex of the Union-Find data structure inheriting a data type.

This is used when accessing the Union-Find Vertex representing a given data is required.

Template Parameters
TType of data. The type has to be default constructible, and cannot be a primitive type, a pointer type or a reference type.

Member Typedef Documentation

◆ 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_specializes()

Constructs a default vertex.

Member Function Documentation

◆ 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