Open
Graph Drawing
Framework

 v.2012.07
 

ogdf::ClusterPlanRep Class Reference

#include <ogdf/cluster/ClusterPlanRep.h>

+ Inheritance diagram for ogdf::ClusterPlanRep:

List of all members.

Public Member Functions

 ClusterPlanRep (const ClusterGraphAttributes &acGraph, const ClusterGraph &clusterGraph)
virtual ~ClusterPlanRep ()
int ClusterID (node v) const
int ClusterID (edge e) const
cluster clusterOfDummy (node v)
cluster clusterOfEdge (edge e)
cluster clusterOfIndex (int i)
virtual void expand (bool lowDegreeExpand=false)
virtual void expandLowDegreeVertices (OrthoRep &OR)
adjEntry externalAdj ()
const ClusterGraphgetClusterGraph () const
void initCC (int i)
 Initializes the planarized representation for connected component i.
void insertEdgePathEmbedded (edge eOrig, CombinatorialEmbedding &E, const SList< adjEntry > &crossedEdges)
bool isClusterBoundary (edge e)
void ModelBoundaries ()
void setClusterBoundary (edge e)
virtual edge split (edge e)
 Splits edge e.
void writeGML (const char *fileName, const Layout &drawing)
void writeGML (const char *fileName)
void writeGML (ostream &os, const Layout &drawing)
- Public Member Functions inherited from ogdf::PlanRep
 PlanRep (const Graph &G)
 PlanRep (const GraphAttributes &AG)
 Creates a planarized representation of graph AG.
virtual ~PlanRep ()
int numberOfCCs () const
 Returns the number of connected components in the original graph.
int currentCC () const
 Returns the index of the current connected component (-1 if not yet initialized).
const List< node > & nodesInCC (int i) const
 Returns the list of (original) nodes in connected component i.
const List< node > & nodesInCC () const
 Returns the list of (original) nodes in the current connected component.
adjEntry expandAdj (node v) const
 Returns the adjacency entry of a node of an expanded face.
adjEntryexpandAdj (node v)
adjEntry boundaryAdj (node v) const
adjEntryboundaryAdj (node v)
void setCliqueBoundary (edge e)
bool isCliqueBoundary (edge e)
Graph::NodeType typeOf (node v) const
 Returns the type of node v.
Graph::NodeTypetypeOf (node v)
 Returns a reference to the type of node v.
bool isVertex (node v)
 Returns true if the node represents a "real" object in the original graph.
nodeType nodeTypeOf (node v)
 Returns the extended node type of v.
void setCrossingType (node v)
 Classifies node v as a crossing.
bool isCrossingType (node v)
 Returns true iff node v is classified as a crossing.
EdgeType typeOf (edge e) const
 Returns the type of edge e.
EdgeTypetypeOf (edge e)
 Returns a reference to the type of edge e.
edgeTypeoriEdgeTypes (edge e)
 Returns a reference to the type of original edge e.
edgeType edgeTypeOf (edge e)
 Returns the new type field of e.
edgeTypeedgeTypes (edge e)
 Returns a reference to the new type field of e.
void setEdgeTypeOf (edge e, edgeType et)
 Sets the new type field of edge e to et.
void setType (edge e, EdgeType et)
 Set both type values of e at once.
bool isGeneralization (edge e)
 Returns true iff edge e is classified as generalization.
void setGeneralization (edge e)
 Classifies edge e as generalization (primary type).
bool isDependency (edge e)
 Returns true iff edge e is classified as dependency.
void setDependency (edge e)
 Classifies edge e as dependency (primary type).
void setAssociation (edge e)
 Classifies edge e as association (primary type).
void setExpansion (edge e)
 Classifies edge e as expansion edge (secondary type).
bool isExpansion (edge e)
 Returns true iff edge e is classified as expansion edge.
bool isBoundary (edge e)
 Returns true iff edge e is a clique boundary.
void setAssClass (edge e)
 Classifies edge e as connection at an association class (tertiary type).
bool isAssClass (edge e)
 Returns true iff edge e is classified as connection at an association class.
void setBrother (edge e)
 Classifies edge e as connection between hierarchy neighbours (fourth level type).
void setHalfBrother (edge e)
 Classifies edge e as connection between ... (fourth level type).
bool isBrother (edge e)
 Returns true if edge e is classified as brother.
bool isHalfBrother (edge e)
 Returns true if edge e is classified as half-brother.
edgeType edgeTypeAND (edge e, edgeType et)
edgeType edgeTypeOR (edge e, edgeType et)
void setPrimaryType (edge e, edgeType et)
void setSecondaryType (edge e, edgeType et)
edgeType edgeTypePrimaryAND (edge e, edgeType et)
edgeType edgeTypePrimaryOR (edge e, edgeType et)
void setUserType (edge e, edgeType et)
bool isUserType (edge e, edgeType et)
void setExpansionEdge (edge e, int expType)
bool isExpansionEdge (edge e) const
int expansionType (edge e) const
bool isDegreeExpansionEdge (edge e) const
const NodeArray< double > & widthOrig () const
 Gives access to the node array of the widths of original nodes.
double widthOrig (node v) const
 Returns the width of original node v.
const NodeArray< double > & heightOrig () const
 Gives access to the node array of the heights of original nodes.
double heightOrig (node v) const
 Returns the height of original node v.
EdgeType typeOrig (edge e) const
 Returns the type of original edge e.
const GraphAttributesgetGraphAttributes () const
 Returns the graph attributes of the original graph (the pointer may be 0).
void collapseVertices (const OrthoRep &OR, Layout &drawing)
void removeCrossing (node v)
void insertBoundary (node center, adjEntry &adjExternal)
node expandedNode (node v) const
void setExpandedNode (node v, node w)
node newCopy (node vOrig, Graph::NodeType vType)
 Creates a new node with node type vType in the planarized representation.
edge newCopy (node v, adjEntry adjAfter, edge eOrig)
 Creates a new edge in the planarized representation.
edge newCopy (node v, adjEntry adjAfter, edge eOrig, CombinatorialEmbedding &E)
 Creates a new edge in the planarized representation while updating the embedding E.
bool embed ()
void removePseudoCrossings ()
void insertEdgePath (edge eOrig, const SList< adjEntry > &crossedEdges)
 Re-inserts edge eOrig by "crossing" the edges in crossedEdges.
void removeEdgePathEmbedded (CombinatorialEmbedding &E, edge eOrig, FaceSetPure &newFaces)
edge insertCrossing (edge &crossingEdge, edge crossedEdge, bool topDown)
 Inserts crossings between two copy edges.
void removeDeg1Nodes (Stack< Deg1RestoreInfo > &S, const NodeArray< bool > &mark)
 Removes all marked degree-1 nodes from the graph copy and stores restore information in S.
void restoreDeg1Nodes (Stack< Deg1RestoreInfo > &S, List< node > &deg1s)
 Restores degree-1 nodes previously removed with removeDeg1Nodes().
- Public Member Functions inherited from ogdf::GraphCopy
 GraphCopy (const Graph &G)
 Creates a graph copy of G.
 GraphCopy ()
 Default constructor (does nothing!).
 GraphCopy (const GraphCopy &GC)
 Copy constructor.
virtual ~GraphCopy ()
const Graphoriginal () const
 Returns a reference to the original graph.
node original (node v) const
 Returns the node in the original graph corresponding to v.
edge original (edge e) const
 Returns the edge in the original graph corresponding to e.
node copy (node v) const
 Returns the node in the graph copy corresponding to v.
const List< edge > & chain (edge e) const
 Returns the list of edges coresponding to edge e.
edge copy (edge e) const
 Returns the first edge in the list of edges coresponding to edge e.
bool isDummy (node v) const
 Returns true iff v has no corresponding node in the original graph.
bool isDummy (edge e) const
 Returns true iff e has no corresponding edge in the original graph.
bool isReversed (edge e) const
 Returns true iff edge e has been reversed.
node newNode ()
 Creates a new node in the graph copy.
node newNode (node vOrig)
 Creates a new node in the graph copy with original node vOrig.
void delCopy (node v)
 Removes node v and all its adjacent edges cleaning-up their corresponding lists of original edges.
void delCopy (edge e)
 Removes edge e and clears the list of edges corresponding to e's original edge.
void unsplit (edge eIn, edge eOut)
 Undoes a previous split operation. The two edges eIn and eOut are merged to a single edge eIn.
edge newEdge (edge eOrig)
 Creates a new edge (v,w) with original edge eOrig.
edge newEdge (edge eOrig, adjEntry adjSrc, node w)
 Creates a new edge with original edge eOrig at predefined positions in the adjacency lists.
edge newEdge (edge eOrig, node v, adjEntry adjTgt)
 Creates a new edge with original edge eOrig at predefined positions in the adjacency lists.
edge newEdge (node v, node w)
 Creates a new edge (v,w) and returns it.
edge newEdge (adjEntry adjSrc, adjEntry adjTgt)
edge newEdge (node v, adjEntry adjTgt)
 Creates a new edge at predefined positions in the adjacency lists.
edge newEdge (adjEntry adjSrc, node w)
 Creates a new edge at predefined positions in the adjacency lists.
void setEdge (edge eOrig, edge eCopy)
 sets eOrig to be the corresponding original edge of eCopy and vice versa
void insertEdgePath (node srcOrig, node tgtOrig, const SList< adjEntry > &crossedEdges)
void removeEdgePath (edge eOrig)
 Removes the complete edge path for edge eOrig.
edge newEdge (node v, adjEntry adj, edge eOrig, CombinatorialEmbedding &E)
 Creates a new edge with original edge eOrig in an embedding E.
void setOriginalEmbedding ()
 Sets the embedding of the graph copy to the embedding of the original graph.
bool consistencyCheck () const
 Checks the consistency of the data structure (for debugging only).
void createEmpty (const Graph &G)
 Associates the graph copy with G, but does not create any nodes or edges.
void initByNodes (const List< node > &nodes, EdgeArray< edge > &eCopy)
 Initializes the graph copy for the nodes in a component.
void initByActiveNodes (const List< node > &nodes, const NodeArray< bool > &activeNodes, EdgeArray< edge > &eCopy)
 Initializes the graph copy for the nodes in nodes.
GraphCopyoperator= (const GraphCopy &GC)
 Assignment operator.
- Public Member Functions inherited from ogdf::Graph
 Graph ()
 Constructs an empty graph.
 Graph (const Graph &G)
 Constructs a graph that is a copy of G.
virtual ~Graph ()
 Destructor.
bool empty () const
 Returns true iff the graph is empty, i.e., contains no nodes.
int numberOfNodes () const
 Returns the number of nodes in the graph.
int numberOfEdges () const
 Returns the number of edges in the graph.
int maxNodeIndex () const
 Returns the largest used node index.
int maxEdgeIndex () const
 Returns the largest used edge index.
int maxAdjEntryIndex () const
 Returns the largest used adjEntry index.
int nodeArrayTableSize () const
 Returns the table size of node arrays associated with this graph.
int edgeArrayTableSize () const
 Returns the table size of edge arrays associated with this graph.
int adjEntryArrayTableSize () const
 Returns the table size of adjEntry arrays associated with this graph.
node firstNode () const
 Returns the first node in the list of all nodes.
node lastNode () const
 Returns the last node in the list of all nodes.
edge firstEdge () const
 Returns the first edge in the list of all edges.
edge lastEdge () const
 Returns the last edge in the list of all edges.
node chooseNode () const
 Returns a randomly chosen node.
edge chooseEdge () const
 Returns a randomly chosen edge.
template<class NODELIST >
void allNodes (NODELIST &nodes) const
 Returns a list with all nodes of the graph.
template<class EDGELIST >
void allEdges (EDGELIST &edges) const
 Returns a list with all edges of the graph.
template<class EDGELIST >
void adjEdges (node v, EDGELIST &edges) const
 Returns a list with all edges adjacent to node v.
template<class ADJLIST >
void adjEntries (node v, ADJLIST &entries) const
 Returns a list with all entries in the adjacency list of node v.
template<class EDGELIST >
void inEdges (node v, EDGELIST &edges) const
 Returns a list with all incoming edges of node v.
template<class EDGELIST >
void outEdges (node v, EDGELIST &edges) const
 Returns a list with all outgoing edges of node v.
node newNode (int index)
 Creates a new node with predefined index and returns it.
edge newEdge (node v, node w, int index)
 Creates a new edge (v,w) with predefined index and returns it.
edge newEdge (adjEntry adjSrc, adjEntry adjTgt, Direction dir=ogdf::after)
 Creates a new edge at predefined positions in the adjacency lists.
void delNode (node v)
 Removes node v and all incident edges from the graph.
void delEdge (edge e)
 Removes edge e from the graph.
void clear ()
 Removes all nodes and all edges from the graph.
void hideEdge (edge e)
 Hides the edge e.
void restoreEdge (edge e)
 Restores a hidden edge e.
void restoreAllEdges ()
 Restores all hidden edges.
void unsplit (node u)
 Undoes a split operation.
node splitNode (adjEntry adjStartLeft, adjEntry adjStartRight)
 Splits a node while preserving the order of adjacency entries.
node contract (edge e)
 Contracts edge e while preserving the order of adjacency entries.
void move (edge e, adjEntry adjSrc, Direction dirSrc, adjEntry adjTgt, Direction dirTgt)
 Moves edge e to a different adjacency list.
void moveTarget (edge e, node w)
 Moves the target node of edge e to node w.
void moveTarget (edge e, adjEntry adjTgt, Direction dir)
 Moves the target node of edge e to a specific position in an adjacency list.
void moveSource (edge e, node w)
 Moves the source node of edge e to node w.
void moveSource (edge e, adjEntry adjSrc, Direction dir)
 Moves the source node of edge e to a specific position in an adjacency list.
edge searchEdge (node v, node w) const
 Searches and returns an edge connecting nodes v and w.
void reverseEdge (edge e)
 Reverses the edge e, i.e., exchanges source and target node.
void reverseAllEdges ()
 Reverses all edges in the graph.
template<class NODELIST >
void collaps (NODELIST &nodes)
 Collapses all nodes in the list nodes to the first node in the list.
template<class ADJ_ENTRY_LIST >
void sort (node v, const ADJ_ENTRY_LIST &newOrder)
 Sorts the adjacency list of node v according to newOrder.
void reverseAdjEdges (node v)
 Reverses the adjacency list of v.
void moveAdj (adjEntry adjMove, Direction dir, adjEntry adjPos)
 Moves adjacency entry adjMove before or after adjPos.
void moveAdjAfter (adjEntry adjMove, adjEntry adjAfter)
 Moves adjacency entry adjMove after adjAfter.
void moveAdjBefore (adjEntry adjMove, adjEntry adjBefore)
 Moves adjacency entry adjMove before adjBefore.
void reverseAdjEdges ()
 Reverses all adjacency lists.
void swapAdjEdges (adjEntry adj1, adjEntry adj2)
 Exchanges two entries in an adjacency list.
bool readGML (const char *fileName)
 Reads a graph in GML format from file fileName.
bool readGML (istream &is)
 Reads a graph in GML format from input stream is.
void writeGML (const char *fileName) const
 Writes the graph in GML format to file fileName.
void writeGML (ostream &os) const
 Writes the graph in GML format to output stream os.
bool readLEDAGraph (const char *fileName)
 Reads a graph in LEDA format from file fileName.
bool readLEDAGraph (istream &is)
 Read a graph in LEDA format from input stream is.
int genus () const
 Returns the genus of the graph's embedding.
bool representsCombEmbedding () const
 Returns true iff the graph represents a combinatorial embedding.
ListIterator< NodeArrayBase * > registerArray (NodeArrayBase *pNodeArray) const
 Registers a node array.
ListIterator< EdgeArrayBase * > registerArray (EdgeArrayBase *pEdgeArray) const
 Registers an edge array.
ListIterator< AdjEntryArrayBase * > registerArray (AdjEntryArrayBase *pAdjArray) const
 Registers an adjEntry array.
ListIterator< GraphObserver * > registerStructure (GraphObserver *pStructure) const
 Registers a graph observer (e.g. a ClusterGraph).
void unregisterArray (ListIterator< NodeArrayBase * > it) const
 Unregisters a node array.
void unregisterArray (ListIterator< EdgeArrayBase * > it) const
 Unregisters an edge array.
void unregisterArray (ListIterator< AdjEntryArrayBase * > it) const
 unregisters an adjEntry array.
void unregisterStructure (ListIterator< GraphObserver * > it) const
 Unregisters a graph observer.
void resetEdgeIdCount (int maxId)
 Resets the edge id count to maxId.
Graphoperator= (const Graph &G)
 Assignment operator.

Protected Member Functions

void convertClusterGraph (cluster act, AdjEntryArray< edge > &currentEdge, AdjEntryArray< int > &outEdge)
void insertBoundary (cluster C, AdjEntryArray< edge > &currentEdge, AdjEntryArray< int > &outEdge, bool clusterIsLeaf)
void reinsertEdge (edge e)
- Protected Member Functions inherited from ogdf::PlanRep
edgeType assClassPattern ()
edgeType associationPattern ()
edgeType brotherPattern ()
edgeType cliquePattern ()
edgeType expansionPattern ()
edgeType generalizationPattern ()
edgeType halfBrotherPattern ()
void removeUnnecessaryCrossing (adjEntry adjA1, adjEntry adjA2, adjEntry adjB1, adjEntry adjB2)
void setCopyType (edge eCopy, edge eOrig)

Private Member Functions

edgeType clusterPattern ()

Private Attributes

HashArray< int, clusterm_clusterOfIndex
EdgeArray< int > m_edgeClusterID
NodeArray< int > m_nodeClusterID
const ClusterGraphm_pClusterGraph
adjEntry m_rootAdj

Additional Inherited Members

- Protected Attributes inherited from ogdf::PlanRep
NodeArray< adjEntrym_boundaryAdj
int m_currentCC
 The index of the current component.
EdgeArray< edgem_eAuxCopy
EdgeArray< edgeTypem_edgeTypes
EdgeArray< EdgeTypem_eType
NodeArray< adjEntrym_expandAdj
NodeArray< nodem_expandedNode
 For all expansion nodes, save expanded node.
EdgeArray< int > m_expansionEdge
Array< List< node > > m_nodesInCC
 The list of original nodes in each component.
NodeArray< nodeTypem_nodeTypes
 Node types for extended semantic information.
int m_numCC
 The number of components in the original graph.
EdgeArray< edgeTypem_oriEdgeTypes
const GraphAttributesm_pGraphAttributes
 Pointer to graph attributes of original graph.
NodeArray< NodeTypem_vType
 Simple node types.
- Protected Attributes inherited from ogdf::GraphCopy
EdgeArray< List< edge > > m_eCopy
 The corresponding list of edges in the graph copy.
EdgeArray< ListIterator< edge > > m_eIterator
 The position of copy edge in the list.
EdgeArray< edgem_eOrig
 The corresponding edge in the original graph.
const Graphm_pGraph
 The original graph.
NodeArray< nodem_vCopy
 The corresponding node in the graph copy.
NodeArray< nodem_vOrig
 The corresponding node in the original graph.

Detailed Description

Definition at line 64 of file ClusterPlanRep.h.


Constructor & Destructor Documentation

ogdf::ClusterPlanRep::ClusterPlanRep ( const ClusterGraphAttributes acGraph,
const ClusterGraph clusterGraph 
)
virtual ogdf::ClusterPlanRep::~ClusterPlanRep ( )
inlinevirtual

Definition at line 73 of file ClusterPlanRep.h.


Member Function Documentation

int ogdf::ClusterPlanRep::ClusterID ( node  v) const
inline

Definition at line 164 of file ClusterPlanRep.h.

int ogdf::ClusterPlanRep::ClusterID ( edge  e) const
inline

Definition at line 165 of file ClusterPlanRep.h.

cluster ogdf::ClusterPlanRep::clusterOfDummy ( node  v)
inline

Definition at line 168 of file ClusterPlanRep.h.

cluster ogdf::ClusterPlanRep::clusterOfEdge ( edge  e)
inline

Definition at line 132 of file ClusterPlanRep.h.

cluster ogdf::ClusterPlanRep::clusterOfIndex ( int  i)
inline

Definition at line 166 of file ClusterPlanRep.h.

edgeType ogdf::ClusterPlanRep::clusterPattern ( )
inlineprivate

Definition at line 201 of file ClusterPlanRep.h.

void ogdf::ClusterPlanRep::convertClusterGraph ( cluster  act,
AdjEntryArray< edge > &  currentEdge,
AdjEntryArray< int > &  outEdge 
)
protected
virtual void ogdf::ClusterPlanRep::expand ( bool  lowDegreeExpand = false)
virtual

Reimplemented from ogdf::PlanRep.

virtual void ogdf::ClusterPlanRep::expandLowDegreeVertices ( OrthoRep OR)
virtual

Reimplemented from ogdf::PlanRep.

adjEntry ogdf::ClusterPlanRep::externalAdj ( )
inline

Definition at line 105 of file ClusterPlanRep.h.

const ClusterGraph& ogdf::ClusterPlanRep::getClusterGraph ( ) const
inline

Definition at line 84 of file ClusterPlanRep.h.

void ogdf::ClusterPlanRep::initCC ( int  i)

Initializes the planarized representation for connected component i.

This initialization is always required. After performing this initialization, the planarized representation represents a copy of the i-th connected component of the original graph, where connected components are numbered 0,1,2,...

Reimplemented from ogdf::PlanRep.

void ogdf::ClusterPlanRep::insertBoundary ( cluster  C,
AdjEntryArray< edge > &  currentEdge,
AdjEntryArray< int > &  outEdge,
bool  clusterIsLeaf 
)
protected
void ogdf::ClusterPlanRep::insertEdgePathEmbedded ( edge  eOrig,
CombinatorialEmbedding E,
const SList< adjEntry > &  crossedEdges 
)

re-inserts edge eOrig by "crossing" the edges in crossedEdges; splits each edge in crossedEdges Precond.: eOrig is an edge in the original graph, the edges in crossedEdges are in this graph, cluster boundaries are modelled as edge paths

Parameters:
eOrig,:Original edge to be inserted
crossedEdges,:Edges that are crossed by this insertion
E,:The embedding in which the edge is inserted

Reimplemented from ogdf::PlanRep.

bool ogdf::ClusterPlanRep::isClusterBoundary ( edge  e)
inline

Definition at line 81 of file ClusterPlanRep.h.

void ogdf::ClusterPlanRep::ModelBoundaries ( )
void ogdf::ClusterPlanRep::reinsertEdge ( edge  e)
protected
void ogdf::ClusterPlanRep::setClusterBoundary ( edge  e)
inline

Definition at line 78 of file ClusterPlanRep.h.

virtual edge ogdf::ClusterPlanRep::split ( edge  e)
inlinevirtual

Splits edge e.

Reimplemented from ogdf::PlanRep.

Definition at line 117 of file ClusterPlanRep.h.

void ogdf::ClusterPlanRep::writeGML ( const char *  fileName,
const Layout drawing 
)
void ogdf::ClusterPlanRep::writeGML ( const char *  fileName)
void ogdf::ClusterPlanRep::writeGML ( ostream &  os,
const Layout drawing 
)

Member Data Documentation

HashArray<int, cluster> ogdf::ClusterPlanRep::m_clusterOfIndex
private

Definition at line 212 of file ClusterPlanRep.h.

EdgeArray<int> ogdf::ClusterPlanRep::m_edgeClusterID
private

Definition at line 208 of file ClusterPlanRep.h.

NodeArray<int> ogdf::ClusterPlanRep::m_nodeClusterID
private

Definition at line 209 of file ClusterPlanRep.h.

const ClusterGraph* ogdf::ClusterPlanRep::m_pClusterGraph
private

Definition at line 199 of file ClusterPlanRep.h.

adjEntry ogdf::ClusterPlanRep::m_rootAdj
private

Definition at line 203 of file ClusterPlanRep.h.


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