Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
Union_find_vertex_data_structure_base Class Reference

Base representation of a vertex in the Union-Find data structure. More...

#include <Union_find.hpp>

Public Types

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

Constructors

 Union_find_vertex_data_structure_base (void)
 Default constructor if uninitalized index. 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

Base representation of a vertex in the Union-Find data structure.

It defines in particular an index used in Union-Find for identifying this vertex.

Member Typedef Documentation

◆ Self

◆ UF_index_type

typedef std::size_t UF_index_type

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

Constructor & Destructor Documentation

◆ Union_find_vertex_data_structure_base()

Default constructor if uninitalized index.

Member Function Documentation

◆ get_union_find_index()

Union_find_vertex_data_structure_base::UF_index_type get_union_find_index ( void  ) const
inline

Access to the Union-Find index.

Precondition
The index is valid.

◆ is_valid_union_find_index()

bool is_valid_union_find_index ( void  ) const
inline

check that the index of the vertex has been initialized