ogdf::EdgeSet Class Reference

Edge sets. More...

#include <ogdf/basic/GraphSets.h>

Inheritance diagram for ogdf::EdgeSet:

Public Member Functions
	EdgeSet (const EdgeSet &copy)=default
	EdgeSet (const Graph &graph)
	Creates a new edge set associated with graph. More...
const list_type &	edges ()
	Returns a reference to the list of edges contained in this set. More...
const Graph &	graphOf () const
	Returns the associated graph. More...
EdgeSet &	operator= (const EdgeSet &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::GraphEdgeRegistry >
	RegisteredSet ()
	Creates an empty set associated with no registry. More...
	RegisteredSet (const internal::GraphEdgeRegistry &R)
	Creates an empty set associated with registry R. More...
	RegisteredSet (const internal::GraphEdgeRegistry *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 internal::GraphEdgeRegistry &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 internal::GraphEdgeRegistry *	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< internal::GraphEdgeRegistry >
using	element_type = typename internal::GraphEdgeRegistry ::key_type
using	list_type = List< element_type >
using	registry_type = internal::GraphEdgeRegistry
Protected Member Functions inherited from ogdf::RegisteredSet< internal::GraphEdgeRegistry >
void	keyAdded (typename internal::GraphEdgeRegistry ::key_type v) override
	Called by watched registry after a key has been added. More...
void	keyRemoved (typename internal::GraphEdgeRegistry ::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::GraphEdgeRegistry *old) override
	Called after reregister() changed the observed instance. More...

Detailed Description

Edge sets.

Maintains a subset of edges contained in an associated graph.

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

Note that an EdgeSet is not notified if an edge is hidden using HiddenEdgeSet. Thus, hidden edges will stay part of EdgeSets even if they are (temporarily) no longer accessible as entry in the edge list of their corresponding Graph.

Definition at line 86 of file GraphSets.h.

Constructor & Destructor Documentation

EdgeSet() [1/2]

ogdf::EdgeSet::EdgeSet ( const Graph &  graph )

inlineexplicit

Creates a new edge set associated with graph.

Definition at line 89 of file GraphSets.h.

EdgeSet() [2/2]

ogdf::EdgeSet::EdgeSet ( const EdgeSet &  copy )

default

Member Function Documentation

edges()

const list_type& ogdf::EdgeSet::edges ( )

inline

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

Definition at line 96 of file GraphSets.h.

graphOf()

const Graph& ogdf::EdgeSet::graphOf ( ) const

inline

Returns the associated graph.

Definition at line 99 of file GraphSets.h.

operator=()

EdgeSet& ogdf::EdgeSet::operator= ( const EdgeSet &  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/basic/GraphSets.h