Open
Graph Drawing
Framework

 v. 2023.09 (Elderberry)
 

ogdf::AdjEntrySet Class Reference

AdjEntry sets. More...

#include <ogdf/basic/GraphSets.h>

+ Inheritance diagram for ogdf::AdjEntrySet:

Public Member Functions

 AdjEntrySet (const AdjEntrySet &copy)=default
 
 AdjEntrySet (const Graph &graph)
 Creates a new adjEntry set associated with graph. More...
 
const list_typeadjEntries ()
 Returns a reference to the list of adjEntries contained in this set. More...
 
const GraphgraphOf () const
 Returns the associated graph. More...
 
AdjEntrySetoperator= (const AdjEntrySet &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< internal::GraphAdjRegistry >
 RegisteredSet ()
 Creates an empty set associated with no registry. More...
 
 RegisteredSet (const internal::GraphAdjRegistry &R)
 Creates an empty set associated with registry R. More...
 
 RegisteredSet (const internal::GraphAdjRegistry *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_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 internal::GraphAdjRegistry &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 &copy)
 
RegisteredSetoperator= (RegisteredSet &&move) noexcept
 
const internal::GraphAdjRegistryregisteredAt () 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< internal::GraphAdjRegistry >
using element_type = typename internal::GraphAdjRegistry ::key_type
 
using list_type = List< element_type >
 
using registry_type = internal::GraphAdjRegistry
 
- Protected Member Functions inherited from ogdf::RegisteredSet< internal::GraphAdjRegistry >
void keyAdded (typename internal::GraphAdjRegistry ::key_type v) override
 Called by watched registry after a key has been added. More...
 
void keyRemoved (typename internal::GraphAdjRegistry ::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 internal::GraphAdjRegistry *old) override
 Called after reregister() changed the observed instance. More...
 

Detailed Description

AdjEntry sets.

Maintains a subset of adjEntries contained in an associated graph.

Provides efficient operations for testing membership, iteration, insertion, and deletion of elements, as well as clearing the set.

Definition at line 114 of file GraphSets.h.

Constructor & Destructor Documentation

◆ AdjEntrySet() [1/2]

ogdf::AdjEntrySet::AdjEntrySet ( const Graph graph)
inlineexplicit

Creates a new adjEntry set associated with graph.

Definition at line 117 of file GraphSets.h.

◆ AdjEntrySet() [2/2]

ogdf::AdjEntrySet::AdjEntrySet ( const AdjEntrySet copy)
default

Member Function Documentation

◆ adjEntries()

const list_type& ogdf::AdjEntrySet::adjEntries ( )
inline

Returns a reference to the list of adjEntries contained in this set.

Definition at line 124 of file GraphSets.h.

◆ graphOf()

const Graph& ogdf::AdjEntrySet::graphOf ( ) const
inline

Returns the associated graph.

Definition at line 127 of file GraphSets.h.

◆ operator=()

AdjEntrySet& ogdf::AdjEntrySet::operator= ( const AdjEntrySet 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: