Open
Graph Drawing
Framework

  v.2007.11
 
Overview Class Hierarchy Class Index Class List Members Namespaces Source Files
Search for: 

ogdf::PlanRep

ogdf::PlanRep Class Reference

Planarized representations (of a connected component) of a graph. More...

#include <PlanRep.h>

Inheritance diagram for ogdf::PlanRep:

ogdf::GraphCopy ogdf::Graph ogdf::ClusterPlanRep ogdf::PlanRepUML ogdf::PlanRepInc

List of all members.

Public Member Functions

 PlanRep (const Graph &G)
 PlanRep (const GraphAttributes &AG)
 Creates a planarized representation of graph AG.
virtual ~PlanRep ()
Processing connected components
Planarized representations provide a mechanism for always representing a copy of a single component of the original graph.

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.
void initCC (int i)
 Initializes the planarized representation for connected component i.
Node expansion
adjEntry expandAdj (node v) const
 Returns the adjacency entry of a node of an expanded face.
adjEntry & expandAdj (node v)
Clique boundary
adjEntry boundaryAdj (node v) const
adjEntry & boundaryAdj (node v)
void setCliqueBoundary (edge e)
bool isCliqueBoundary (edge e)
Node types
Graph::NodeType typeOf (node v) const
 Returns the type of node v.
Graph::NodeType & typeOf (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.
Edge types
EdgeType typeOf (edge e) const
 Returns the type of edge e.
EdgeType & typeOf (edge e)
 Returns a reference to the type of edge e.
edgeType & oriEdgeTypes (edge e)
 Returns a reference to the type of original edge e.
edgeType edgeTypeOf (edge e)
 Returns the new type field of e.
edgeType & edgeTypes (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
Access to attributes in original graph
These methods provide easy access to attributes of original nodes and edges.

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 GraphAttributes & getGraphAttributes () const
 Returns the graph attributes of the original graph (the pointer may be 0).
Structural alterations
void expand (bool lowDegreeExpand=false)
void expandLowDegreeVertices (OrthoRep &OR)
void collapseVertices (const OrthoRep &OR, Layout &drawing)
void removeCrossing (node v)
void insertBoundary (node center, adjEntry &adjExternal)
Extension of methods defined by GraphCopys
virtual edge split (edge e)
 Splits edge e.
node expandedNode (node v) const
void setExpandedNode (node v, node w)
Creation of new nodes and edges
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.
Crossings
bool embed ()
void removePseudoCrossings ()
void insertEdgePath (edge eOrig, const SList< adjEntry > &crossedEdges)
 Re-inserts edge eOrig by "crossing" the edges in crossedEdges.
void insertEdgePathEmbedded (edge eOrig, CombinatorialEmbedding &E, const SList< adjEntry > &crossedEdges)
 Re-inserts edge eOrig by "crossing" the edges in crossedEdges in embedding E.
void removeEdgePathEmbedded (CombinatorialEmbedding &E, edge eOrig, FaceSetPure &newFaces)
edge insertCrossing (edge &crossingEdge, const edge crossedEdge, bool topDown)
 Inserts crossings between already existing edges (used in TopologyModule).
Degree-1 nodes
These methods realize a mechanism for temporarily removing degree-1 nodes.

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().

Protected Member Functions

void setCopyType (edge eCopy, edge eOrig)
edgeType generalizationPattern ()
edgeType associationPattern ()
edgeType expansionPattern ()
edgeType assClassPattern ()
edgeType brotherPattern ()
edgeType halfBrotherPattern ()
edgeType cliquePattern ()
void removeUnnecessaryCrossing (adjEntry adjA1, adjEntry adjA2, adjEntry adjB1, adjEntry adjB2)

Protected Attributes

int m_currentCC
 The index of the current component.
int m_numCC
 The number of components in the original graph.
Array< List< node > > m_nodesInCC
 The list of original nodes in each component.
const GraphAttributes * m_pGraphAttributes
 Pointer to graph attributes of original graph.
NodeArray< NodeType > m_vType
 Simple node types.
NodeArray< nodeType > m_nodeTypes
 Node types for extended semantic information.
NodeArray< node > m_expandedNode
 For all expansion nodes, save expanded node.
NodeArray< adjEntry > m_expandAdj
NodeArray< adjEntry > m_boundaryAdj
EdgeArray< int > m_expansionEdge
EdgeArray< EdgeType > m_eType
EdgeArray< edgeType > m_edgeTypes
EdgeArray< edgeType > m_oriEdgeTypes
EdgeArray< edge > m_eAuxCopy

Classes

struct  Deg1RestoreInfo
 Information for restoring degree-1 nodes. More...

Detailed Description

Planarized representations (of a connected component) of a graph.

Maintains types of edges (generalization, association) and nodes, and the connected components of the graph.

Definition at line 81 of file PlanRep.h.

Constructor & Destructor Documentation

ogdf::PlanRep::PlanRep ( const Graph &  G  ) 

ogdf::PlanRep::PlanRep ( const GraphAttributes &  AG  ) 

Creates a planarized representation of graph AG.

virtual ogdf::PlanRep::~PlanRep (  )  [inline, virtual]

Definition at line 107 of file PlanRep.h.

Member Function Documentation

int ogdf::PlanRep::numberOfCCs (  )  const [inline]

Returns the number of connected components in the original graph.

Definition at line 121 of file PlanRep.h.

int ogdf::PlanRep::currentCC (  )  const [inline]

Returns the index of the current connected component (-1 if not yet initialized).

Definition at line 128 of file PlanRep.h.

const List<node>& ogdf::PlanRep::nodesInCC ( int  i  )  const [inline]

Returns the list of (original) nodes in connected component i.

Note that connected components are numbered 0,1,...

Definition at line 137 of file PlanRep.h.

const List<node>& ogdf::PlanRep::nodesInCC (  )  const [inline]

Returns the list of (original) nodes in the current connected component.

Definition at line 144 of file PlanRep.h.

void ogdf::PlanRep::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 in ogdf::ClusterPlanRep, and ogdf::PlanRepUML.

adjEntry ogdf::PlanRep::expandAdj ( node  v  )  const [inline]

Returns the adjacency entry of a node of an expanded face.

If no such entry is stored at node v, 0 is returned.

Definition at line 170 of file PlanRep.h.

adjEntry& ogdf::PlanRep::expandAdj ( node  v  )  [inline]

Definition at line 174 of file PlanRep.h.

adjEntry ogdf::PlanRep::boundaryAdj ( node  v  )  const [inline]

Returns the adjacency entry of the first edge of the inserted boundary at a center node (original) of a clique, 0 if no boundary exists

Definition at line 188 of file PlanRep.h.

adjEntry& ogdf::PlanRep::boundaryAdj ( node  v  )  [inline]

Returns a reference to the adjacency entry of the first edge of the inserted boundary at a center node (original) of a clique, 0 if no boundary exists

Definition at line 196 of file PlanRep.h.

void ogdf::PlanRep::setCliqueBoundary ( edge  e  )  [inline]

Definition at line 201 of file PlanRep.h.

bool ogdf::PlanRep::isCliqueBoundary ( edge  e  )  [inline]

Definition at line 204 of file PlanRep.h.

Graph::NodeType ogdf::PlanRep::typeOf ( node  v  )  const [inline]

Returns the type of node v.

Parameters:
v is a node in the planarized representation.

Definition at line 219 of file PlanRep.h.

Graph::NodeType& ogdf::PlanRep::typeOf ( node  v  )  [inline]

Returns a reference to the type of node v.

Parameters:
v is a node in the planarized representation.

Definition at line 227 of file PlanRep.h.

bool ogdf::PlanRep::isVertex ( node  v  )  [inline]

Returns true if the node represents a "real" object in the original graph.

Todo:
It is necessary to check for several different possible types. This should be solved by combining representation types (vertex, dummy,...) with semantic types (class, interface,...) within GraphAttributes; we then can return to vertex only.

Definition at line 239 of file PlanRep.h.

nodeType ogdf::PlanRep::nodeTypeOf ( node  v  )  [inline]

Returns the extended node type of v.

Parameters:
v is a node in the planarized representation.

Definition at line 249 of file PlanRep.h.

void ogdf::PlanRep::setCrossingType ( node  v  )  [inline]

Classifies node v as a crossing.

Parameters:
v is a node in the planarized representation.

Definition at line 258 of file PlanRep.h.

bool ogdf::PlanRep::isCrossingType ( node  v  )  [inline]

Returns true iff node v is classified as a crossing.

Parameters:
v is a node in the planarized representation.

Definition at line 267 of file PlanRep.h.

EdgeType ogdf::PlanRep::typeOf ( edge  e  )  const [inline]

Returns the type of edge e.

Parameters:
e is an edge in the planarized representation.

Definition at line 282 of file PlanRep.h.

EdgeType& ogdf::PlanRep::typeOf ( edge  e  )  [inline]

Returns a reference to the type of edge e.

Parameters:
e is an edge in the planarized representation.

Definition at line 290 of file PlanRep.h.

edgeType& ogdf::PlanRep::oriEdgeTypes ( edge  e  )  [inline]

Returns a reference to the type of original edge e.

Parameters:
e is an edge in the original graph.

Definition at line 298 of file PlanRep.h.

edgeType ogdf::PlanRep::edgeTypeOf ( edge  e  )  [inline]

Returns the new type field of e.

Parameters:
e is an edge in the planarized representation.

Definition at line 307 of file PlanRep.h.

edgeType& ogdf::PlanRep::edgeTypes ( edge  e  )  [inline]

Returns a reference to the new type field of e.

Parameters:
e is an edge in the planarized representation.

Definition at line 316 of file PlanRep.h.

void ogdf::PlanRep::setEdgeTypeOf ( edge  e,
edgeType  et 
) [inline]

Sets the new type field of edge e to et.

Parameters:
e is an edge in the planarized representation.
et is the type assigned to e.

Definition at line 326 of file PlanRep.h.

void ogdf::PlanRep::setType ( edge  e,
EdgeType  et 
) [inline]

Set both type values of e at once.

This is a temporary solution that sets both type values; this way, all additional edge types in the new field are lost.

Parameters:
e is an edge in the planarized representation.
et is the type assigned to e.

Definition at line 339 of file PlanRep.h.

bool ogdf::PlanRep::isGeneralization ( edge  e  )  [inline]

Returns true iff edge e is classified as generalization.

Definition at line 360 of file PlanRep.h.

void ogdf::PlanRep::setGeneralization ( edge  e  )  [inline]

Classifies edge e as generalization (primary type).

Definition at line 368 of file PlanRep.h.

bool ogdf::PlanRep::isDependency ( edge  e  )  [inline]

Returns true iff edge e is classified as dependency.

Definition at line 376 of file PlanRep.h.

void ogdf::PlanRep::setDependency ( edge  e  )  [inline]

Classifies edge e as dependency (primary type).

Definition at line 384 of file PlanRep.h.

void ogdf::PlanRep::setAssociation ( edge  e  )  [inline]

Classifies edge e as association (primary type).

Definition at line 392 of file PlanRep.h.

void ogdf::PlanRep::setExpansion ( edge  e  )  [inline]

Classifies edge e as expansion edge (secondary type).

Definition at line 405 of file PlanRep.h.

bool ogdf::PlanRep::isExpansion ( edge  e  )  [inline]

Returns true iff edge e is classified as expansion edge.

Definition at line 413 of file PlanRep.h.

bool ogdf::PlanRep::isBoundary ( edge  e  )  [inline]

Returns true iff edge e is a clique boundary.

Definition at line 420 of file PlanRep.h.

void ogdf::PlanRep::setAssClass ( edge  e  )  [inline]

Classifies edge e as connection at an association class (tertiary type).

Definition at line 427 of file PlanRep.h.

bool ogdf::PlanRep::isAssClass ( edge  e  )  [inline]

Returns true iff edge e is classified as connection at an association class.

Definition at line 433 of file PlanRep.h.

void ogdf::PlanRep::setBrother ( edge  e  )  [inline]

Classifies edge e as connection between hierarchy neighbours (fourth level type).

Definition at line 443 of file PlanRep.h.

void ogdf::PlanRep::setHalfBrother ( edge  e  )  [inline]

Classifies edge e as connection between ... (fourth level type).

Definition at line 448 of file PlanRep.h.

bool ogdf::PlanRep::isBrother ( edge  e  )  [inline]

Returns true if edge e is classified as brother.

Definition at line 453 of file PlanRep.h.

bool ogdf::PlanRep::isHalfBrother ( edge  e  )  [inline]

Returns true if edge e is classified as half-brother.

Definition at line 458 of file PlanRep.h.

edgeType ogdf::PlanRep::edgeTypeAND ( edge  e,
edgeType  et 
) [inline]

Definition at line 465 of file PlanRep.h.

edgeType ogdf::PlanRep::edgeTypeOR ( edge  e,
edgeType  et 
) [inline]

Definition at line 467 of file PlanRep.h.

void ogdf::PlanRep::setPrimaryType ( edge  e,
edgeType  et 
) [inline]

Definition at line 471 of file PlanRep.h.

void ogdf::PlanRep::setSecondaryType ( edge  e,
edgeType  et 
) [inline]

Definition at line 474 of file PlanRep.h.

edgeType ogdf::PlanRep::edgeTypePrimaryAND ( edge  e,
edgeType  et 
) [inline]

Definition at line 478 of file PlanRep.h.

edgeType ogdf::PlanRep::edgeTypePrimaryOR ( edge  e,
edgeType  et 
) [inline]

Definition at line 481 of file PlanRep.h.

void ogdf::PlanRep::setUserType ( edge  e,
edgeType  et 
) [inline]

Definition at line 484 of file PlanRep.h.

bool ogdf::PlanRep::isUserType ( edge  e,
edgeType  et 
) [inline]

Definition at line 490 of file PlanRep.h.

void ogdf::PlanRep::setExpansionEdge ( edge  e,
int  expType 
) [inline]

Definition at line 506 of file PlanRep.h.

bool ogdf::PlanRep::isExpansionEdge ( edge  e  )  const [inline]

Definition at line 510 of file PlanRep.h.

int ogdf::PlanRep::expansionType ( edge  e  )  const [inline]

Definition at line 514 of file PlanRep.h.

bool ogdf::PlanRep::isDegreeExpansionEdge ( edge  e  )  const [inline]

Definition at line 517 of file PlanRep.h.

const NodeArray<double>& ogdf::PlanRep::widthOrig (  )  const [inline]

Gives access to the node array of the widths of original nodes.

Definition at line 533 of file PlanRep.h.

double ogdf::PlanRep::widthOrig ( node  v  )  const [inline]

Returns the width of original node v.

Definition at line 538 of file PlanRep.h.

const NodeArray<double>& ogdf::PlanRep::heightOrig (  )  const [inline]

Gives access to the node array of the heights of original nodes.

Definition at line 543 of file PlanRep.h.

double ogdf::PlanRep::heightOrig ( node  v  )  const [inline]

Returns the height of original node v.

Definition at line 548 of file PlanRep.h.

EdgeType ogdf::PlanRep::typeOrig ( edge  e  )  const [inline]

Returns the type of original edge e.

Definition at line 553 of file PlanRep.h.

const GraphAttributes& ogdf::PlanRep::getGraphAttributes (  )  const [inline]

Returns the graph attributes of the original graph (the pointer may be 0).

Definition at line 558 of file PlanRep.h.

void ogdf::PlanRep::expand ( bool  lowDegreeExpand = false  ) 

Reimplemented in ogdf::ClusterPlanRep, and ogdf::PlanRepUML.

void ogdf::PlanRep::expandLowDegreeVertices ( OrthoRep &  OR  ) 

Reimplemented in ogdf::ClusterPlanRep.

void ogdf::PlanRep::collapseVertices ( const OrthoRep &  OR,
Layout &  drawing 
)

Reimplemented in ogdf::PlanRepUML.

void ogdf::PlanRep::removeCrossing ( node  v  ) 

void ogdf::PlanRep::insertBoundary ( node  center,
adjEntry &  adjExternal 
)

virtual edge ogdf::PlanRep::split ( edge  e  )  [virtual]

Splits edge e.

Reimplemented from ogdf::GraphCopy.

Reimplemented in ogdf::ClusterPlanRep, ogdf::PlanRepInc, and ogdf::PlanRepUML.

node ogdf::PlanRep::expandedNode ( node  v  )  const [inline]

Definition at line 593 of file PlanRep.h.

void ogdf::PlanRep::setExpandedNode ( node  v,
node  w 
) [inline]

Definition at line 595 of file PlanRep.h.

node ogdf::PlanRep::newCopy ( node  vOrig,
Graph::NodeType  vType 
)

Creates a new node with node type vType in the planarized representation.

Parameters:
vOrig becomes the original node of the new node.
vType becomes the type of the new node.

edge ogdf::PlanRep::newCopy ( node  v,
adjEntry  adjAfter,
edge  eOrig 
)

Creates a new edge in the planarized representation.

Parameters:
v is the source node of the new edge.
adjAfter is the adjacency entry at the target node, after which the new edge is inserted.
eOrig becomes the original edge of the new edge.

edge ogdf::PlanRep::newCopy ( node  v,
adjEntry  adjAfter,
edge  eOrig,
CombinatorialEmbedding &  E 
)

Creates a new edge in the planarized representation while updating the embedding E.

Parameters:
v is the source node of the new edge.
adjAfter is the adjacency entry at the target node, after which the new edge is inserted.
eOrig becomes the original edge of the new edge.
E is an embedding of the planarized representation.

bool ogdf::PlanRep::embed (  ) 

void ogdf::PlanRep::removePseudoCrossings (  ) 

void ogdf::PlanRep::insertEdgePath ( edge  eOrig,
const SList< adjEntry > &  crossedEdges 
)

Re-inserts edge eOrig by "crossing" the edges in crossedEdges.

Let v and w be the copies of the source and target nodes of eOrig. Each edge in crossedEdges is split creating a sequence $u_1,\ldots,u_k$ of new nodes, and additional edges are inserted creating a path $v,u_1,\ldots,u_k,w$.

Parameters:
eOrig is an edge in the original graph and becomes the original edge of all edges in the path