Open
Graph Drawing
Framework

 v. 2023.09 (Elderberry)
 

ogdf::ClusterSet< SupportFastSizeQuery > Class Template Reference

Cluster sets. More...

#include <ogdf/cluster/ClusterSet.h>

+ Inheritance diagram for ogdf::ClusterSet< SupportFastSizeQuery >:

Public Member Functions

const RS::list_typeclusters () const
 Returns a reference to the list of clusters contained in S. More...
 
- Public Member Functions inherited from ogdf::RegisteredSet< ClusterGraph, true >
 RegisteredSet ()
 Creates an empty set associated with no registry. More...
 
 RegisteredSet (const ClusterGraph &R)
 Creates an empty set associated with registry R. More...
 
 RegisteredSet (const RegisteredSet< ClusterGraph, OtherSupportsFastSizeQuery > &other)
 Copy constructor. More...
 
list_type::const_iterator begin () const
 
void clear ()
 Removes all elements from this set. More...
 
const list_typeelements () const
 Returns a reference to the list of elements contained in this set. More...
 
list_type::const_iterator end () const
 
void init ()
 Reinitializes the set. Associates the set with no registry. More...
 
void init (const ClusterGraph &R)
 Reinitializes the set. Associates the set with registry R. More...
 
void insert (element_type v)
 Inserts element v into this set. More...
 
bool isMember (element_type v) const
 Returns true iff element v is contained in this set. More...
 
bool operator() (element_type v) const
 Returns the same as isMember() to use an RegisteredSet instance as filter function. More...
 
RegisteredSetoperator= (const RegisteredSet< ClusterGraph, OtherSupportsFastSizeQuery > &other)
 Assignment operator. More...
 
const ClusterGraphregisteredAt () const
 Returns the associated registry. More...
 
bool remove (element_type v)
 Removes element v from this set and return true iff v was previously present. More...
 
int size () const
 Returns the number of elements in this set. More...
 

Private Types

using RS = RegisteredSet< ClusterGraph, SupportFastSizeQuery >
 

Additional Inherited Members

- Public Types inherited from ogdf::RegisteredSet< ClusterGraph, true >
using element_type = typename ClusterGraph ::key_type
 
using list_type = typename std::conditional< SupportFastSizeQuery, List< element_type >, ListPure< element_type > >::type
 

Detailed Description

template<bool SupportFastSizeQuery = true>
class ogdf::ClusterSet< SupportFastSizeQuery >

Cluster sets.

A cluster set maintains a subset S of the clusters contained in an associated clustered graph. This kind of cluster set provides efficient operations for testing membership, insertion and deletion of elements, and clearing the set.

Template Parameters
SupportFastSizeQueryWhether this set supports querying its size in constant instead of linear time (in the size).

Definition at line 51 of file ClusterSet.h.

Member Typedef Documentation

◆ RS

template<bool SupportFastSizeQuery = true>
using ogdf::ClusterSet< SupportFastSizeQuery >::RS = RegisteredSet<ClusterGraph, SupportFastSizeQuery>
private

Definition at line 52 of file ClusterSet.h.

Member Function Documentation

◆ clusters()

template<bool SupportFastSizeQuery = true>
const RS::list_type& ogdf::ClusterSet< SupportFastSizeQuery >::clusters ( ) const
inline

Returns a reference to the list of clusters contained in S.

This list can be used for iterating over all clusters in S.

Definition at line 61 of file ClusterSet.h.


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