ogdf::ClusterSet Class Reference

Cluster sets. More...

#include <ogdf/cluster/ClusterSet.h>

Inheritance diagram for ogdf::ClusterSet:

Public Member Functions
	ClusterSet (const ClusterSet &copy)=default
const list_type &	clusters () const
	Returns a reference to the list of clusters contained in S. More...
ClusterSet &	operator= (const ClusterSet &copy)=default
	RegisteredSet ()
	Creates an empty set associated with no registry. More...
	RegisteredSet (const RegisteredSet &copy)
	RegisteredSet (const Registry &R)
	Creates an empty set associated with registry R. More...
	RegisteredSet (const Registry *R)
	Creates an empty set associated with registry R. More...
	RegisteredSet (RegisteredSet &&move) noexcept
Public Member Functions inherited from ogdf::RegisteredSet< ClusterGraph >
	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 ClusterGraph *R)
	Creates an empty set associated with registry R. More...
	RegisteredSet (const RegisteredSet &copy)
	RegisteredSet (RegisteredSet &&move) noexcept
list_type::const_iterator	begin () const
void	clear ()
	Removes all elements from this set. More...
bool	contains (element_type v) const
	Returns the same as isMember() More...
const list_type &	elements () 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...
RegisteredSet &	operator= (const RegisteredSet &copy)
RegisteredSet &	operator= (RegisteredSet &&move) noexcept
const ClusterGraph *	registeredAt () 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...

Additional Inherited Members
Public Types inherited from ogdf::RegisteredSet< ClusterGraph >
using	element_type = typename ClusterGraph ::key_type
using	list_type = List< element_type >
using	registry_type = ClusterGraph
Protected Member Functions inherited from ogdf::RegisteredSet< ClusterGraph >
void	keyAdded (typename ClusterGraph ::key_type v) override
	Called by watched registry after a key has been added. More...
void	keyRemoved (typename ClusterGraph ::key_type v) override
	Called by watched registry just before a key is deleted. More...
void	keysCleared () override
	Called by watched registry when its clear function is called, just before things are removed. More...
void	keysCopied (int toIndex, int fromIndex) override
	Called when an entry is copied from fromIndex to toIndex in all registered arrays. More...
void	keysSwapped (int index1, int index2) override
	Called when an entry is swapped between index1 and index2 in all registered arrays. More...
void	registrationChanged (const ClusterGraph *old) override
	Called after reregister() changed the observed instance. More...

Detailed Description

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.

Definition at line 48 of file ClusterSet.h.

Constructor & Destructor Documentation

ClusterSet()

ogdf::ClusterSet::ClusterSet ( const ClusterSet &  copy )

default

Member Function Documentation

clusters()

const list_type& ogdf::ClusterSet::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 57 of file ClusterSet.h.

operator=()

ClusterSet& ogdf::ClusterSet::operator= ( const ClusterSet &  copy )

default

RegisteredSet() [1/5]

ogdf::RegisteredSet< Registry >::RegisteredSet

inlineexplicit

Creates an empty set associated with no registry.

Definition at line 72 of file RegisteredSet.h.

RegisteredSet() [2/5]

ogdf::RegisteredSet< Registry >::RegisteredSet

inline

Definition at line 74 of file RegisteredSet.h.

RegisteredSet() [3/5]

ogdf::RegisteredSet< Registry >::RegisteredSet

inlineexplicit

Creates an empty set associated with registry R.

Definition at line 62 of file RegisteredSet.h.

RegisteredSet() [4/5]

ogdf::RegisteredSet< Registry >::RegisteredSet

inlineexplicit

Creates an empty set associated with registry R.

Definition at line 69 of file RegisteredSet.h.

RegisteredSet() [5/5]

ogdf::RegisteredSet< Registry >::RegisteredSet

inlinenoexcept

Definition at line 85 of file RegisteredSet.h.

---

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

• include/ogdf/cluster/ClusterSet.h