# OpenGraph DrawingFramework

v. 2022.02 (Dogwood)

ogdf::PlanRep Class Reference

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

#include <ogdf/planarity/PlanRep.h>

Inheritance diagram for ogdf::PlanRep:

## Classes

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

## Public Member Functions

PlanRep (const Graph &G)
Creates a planarized representation of graph G. More...

PlanRep (const GraphAttributes &AG)
Creates a planarized representation of graph AG. More...

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. More...

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

const CCsInfoccInfo () const
Returns the connected components info structure. More...

int numberOfNodesInCC () const
Returns the number of nodes in the current connected component. More...

int numberOfNodesInCC (int cc) const
Returns the number of nodes in connected component cc. More...

node v (int i) const
Returns node i in the list of all original nodes. More...

edge e (int i) const
Returns edge i in the list of all original edges. More...

int startNode () const
Returns the index of the first node in this connected component. More...

int startNode (int cc) const
Returns the index of the first node in connected component cc. More...

int stopNode () const
Returns the index of (one past) the last node in this connected component. More...

int stopNode (int cc) const
Returns the index of (one past) the last node in connected component cc. More...

int startEdge () const
Returns the index of the first edge in this connected component. More...

int stopEdge () const
Returns the index of (one past) the last edge in this connected component. More...

void initCC (int cc)
Initializes the planarized representation for connected component cc. More...

Node expansion
Returns the adjacency entry of a node of an expanded face. More...

Clique boundary
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. More...

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. More...

void setCliqueBoundary (edge e)

bool isCliqueBoundary (edge e) const

Node types
Graph::NodeType typeOf (node v) const
Returns the type of node v. More...

Graph::NodeTypetypeOf (node v)
Returns a reference to the type of node v. More...

bool isVertex (node v) const
Returns true if the node represents a "real" object in the original graph. More...

nodeType nodeTypeOf (node v)
Returns the extended node type of v. More...

void setCrossingType (node v)
Classifies node v as a crossing. More...

bool isCrossingType (node v) const
Returns true iff node v is classified as a crossing. More...

Edge types
EdgeType typeOf (edge e) const
Returns the type of edge e. More...

EdgeTypetypeOf (edge e)
Returns a reference to the type of edge e. More...

edgeTypeoriEdgeTypes (edge e)
Returns a reference to the type of original edge e. More...

edgeType edgeTypeOf (edge e) const
Returns the new type field of e. More...

edgeTypeedgeTypes (edge e)
Returns a reference to the new type field of e. More...

void setEdgeTypeOf (edge e, edgeType et)
Sets the new type field of edge e to et. More...

void setType (edge e, EdgeType et)
Set both type values of e at once. More...

bool isGeneralization (edge e) const
Returns true iff edge e is classified as generalization. More...

void setGeneralization (edge e)
Classifies edge e as generalization (primary type). More...

bool isDependency (edge e) const
Returns true iff edge e is classified as dependency. More...

void setDependency (edge e)
Classifies edge e as dependency (primary type). More...

void setAssociation (edge e)
Classifies edge e as association (primary type). More...

void setExpansion (edge e)
Classifies edge e as expansion edge (secondary type). More...

bool isExpansion (edge e) const
Returns true iff edge e is classified as expansion edge. More...

bool isBoundary (edge e) const
Returns true iff edge e is a clique boundary. More...

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

bool isAssClass (edge e) const
Returns true iff edge e is classified as connection at an association class. More...

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

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

bool isBrother (edge e) const
Returns true if edge e is classified as brother. More...

bool isHalfBrother (edge e) const
Returns true if edge e is classified as half-brother. More...

edgeType edgeTypeAND (edge e, edgeType et)
Sets type of edge e to current type (bitwise) AND et. More...

edgeType edgeTypeOR (edge e, edgeType et)
Sets type of edge e to current type (bitwise) OR et. More...

void setPrimaryType (edge e, edgeType et)
Sets primary edge type of edge e to primary edge type in et (deletes old primary value). More...

void setPrimaryType (edge e, UMLEdgeTypeConstants et)
Sets primary edge type of edge e to primary edge type in et (deletes old primary value). More...

void setSecondaryType (edge e, edgeType et)
Sets secondary edge type of edge e to primary edge type in et. More...

edgeType edgeTypePrimaryAND (edge e, edgeType et)
Sets primary type of e to bitwise AND of et's primary value and old value. More...

edgeType edgeTypePrimaryOR (edge e, edgeType et)
Sets primary type of e to bitwise OR of et's primary value and old value. More...

void setUserType (edge e, edgeType et)
Sets user defined type locally. More...

bool isUserType (edge e, edgeType et) const
Returns user defined type. More...

void setExpansionEdge (edge e, int expType)
Sets the expansion edge type of e to expType. More...

bool isExpansionEdge (edge e) const
Returns if e is an expansion edge. More...

int expansionType (edge e) const
Returns the expansion edge type of e. More...

bool isDegreeExpansionEdge (edge e) const
Returns if e is a degree expansion edge. More...

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. More...

double widthOrig (node v) const
Returns the width of original node v. More...

const NodeArray< double > & heightOrig () const
Gives access to the node array of the heights of original nodes. More...

double heightOrig (node v) const
Returns the height of original node v. More...

EdgeType typeOrig (edge e) const
Returns the type of original edge e. More...

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

Structural alterations
virtual void expand (bool lowDegreeExpand=false)

void expandLowDegreeVertices (OrthoRep &OR)

void collapseVertices (const OrthoRep &OR, Layout &drawing)

void collapseVertices (const OrthoRep &OR, GridLayout &drawing)

void removeCrossing (node v)

Extension of methods defined by GraphCopys
virtual edge split (edge e) override
Splits edge e. More...

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. More...

Creates a new edge in the planarized representation. More...

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

Crossings
void insertEdgePath (edge eOrig, const SList< adjEntry > &crossedEdges)
Re-inserts edge eOrig by "crossing" the edges in crossedEdges. More...

void insertEdgePathEmbedded (edge eOrig, CombinatorialEmbedding &E, const SList< adjEntry > &crossedEdges)
Same as insertEdgePath, but for embedded graphs. More...

void removeEdgePathEmbedded (CombinatorialEmbedding &E, edge eOrig, FaceSet< false > &newFaces)
Removes the complete edge path for edge eOrig while preserving the embedding. More...

edge insertCrossing (edge &crossingEdge, edge crossedEdge, bool topDown)
Inserts crossings between two copy edges. More...

Public Member Functions inherited from ogdf::GraphCopy
GraphCopy ()
Default constructor (does nothing!). More...

GraphCopy (const Graph &G)
Creates a graph copy of G. More...

GraphCopy (const GraphCopy &GC)
Copy constructor. More...

virtual ~GraphCopy ()

const Graphoriginal () const
Returns a reference to the original graph. More...

node original (node v) const
Returns the node in the original graph corresponding to v. More...

edge original (edge e) const
Returns the edge in the original graph corresponding to e. More...

Returns the adjacency entry in the original graph corresponding to adj. More...

node copy (node v) const
Returns the node in the graph copy corresponding to v. More...

const List< edge > & chain (edge e) const
Returns the list of edges coresponding to edge e. More...

edge copy (edge e) const
Returns the first edge in the list of edges coresponding to edge e. More...

Returns the adjacency entry in the copy graph corresponding to adj. More...

bool isDummy (node v) const
Returns true iff v has no corresponding node in the original graph. More...

bool isDummy (edge e) const
Returns true iff e has no corresponding edge in the original graph. More...

bool isReversed (edge e) const
Returns true iff edge e has been reversed. More...

bool isReversedCopyEdge (edge e) const
Returns true iff e is reversed w.r.t. More...

node newNode (node vOrig)
Creates a new node in the graph copy with original node vOrig. More...

virtual void delNode (node v) override
Removes node v and all its adjacent edges cleaning-up their corresponding lists of original edges. More...

virtual void delEdge (edge e) override
Removes edge e and clears the list of edges corresponding to e's original edge. More...

virtual void clear () override
Removes all nodes and all edges from the graph. More...

void unsplit (edge eIn, edge eOut) override
Undoes a previous split operation. More...

edge newEdge (edge eOrig)
Creates a new edge (v,w) with original edge eOrig. More...

void setEdge (edge eOrig, edge eCopy)
sets eOrig to be the corresponding original edge of eCopy and vice versa More...

bool embed ()
Embeds the graph copy. More...

void removePseudoCrossings ()
Removes all crossing nodes which are actually only two "touching" edges. More...

bool hasSameEdgesCrossings () const
Returns whether there are two edges in the GraphCopy that cross each other multiple times. More...

Returns whether the GraphCopy contains at least one crossing of two adjacent edges. More...

bool hasNonSimpleCrossings () const
Returns whether the GraphCopy contains crossings that will result in a non-simple drawing. More...

void removeNonSimpleCrossings (SListPure< edge > &edgesToCheck, DynamicDualGraph *dualGraph=nullptr)
Removes all non-simple cossings involving edges from edgesToCheck (see hasNonSimpleCrossings() for a definition of non-simple crossings). More...

void removeNonSimpleCrossings (DynamicDualGraph *dualGraph=nullptr)
Removes all non-simple cossings (see hasNonSimpleCrossings() for a definition of non-simple crossings). More...

void removeNonSimpleCrossings (node origNode, DynamicDualGraph *dualGraph=nullptr)
Removes all non-simple cossings involving edges incident to origNode (see hasNonSimpleCrossings() for a definition of non-simple crossings). More...

void insertEdgePath (edge eOrig, const SList< adjEntry > &crossedEdges)
Re-inserts edge eOrig by "crossing" the edges in crossedEdges. More...

void insertEdgePath (node srcOrig, node tgtOrig, const SList< adjEntry > &crossedEdges)
Special version (for FixedEmbeddingUpwardEdgeInserter only). More...

void removeEdgePath (edge eOrig)
Removes the complete edge path for edge eOrig. More...

edge insertCrossing (edge &crossingEdge, edge crossedEdge, bool rightToLeft)
Inserts crossings between two copy edges. More...

node newNode ()
Creates a new node and returns it. More...

node newNode (int index)
Creates a new node with predefined index and returns it. More...

edge newEdge (node v, node w)
Creates a new edge (v,w) and returns it. More...

edge newEdge (node v, node w, int index)
Creates a new edge (v,w) with predefined index and returns it. More...

Creates a new edge at predefined positions in the adjacency lists. More...

Creates a new edge at predefined positions in the adjacency lists. More...

Creates a new edge at predefined positions in the adjacency lists. More...

Creates a new edge with original edge eOrig in an embedding E. More...

void setOriginalEmbedding ()
Sets the embedding of the graph copy to the embedding of the original graph. More...

void insertEdgePathEmbedded (edge eOrig, CombinatorialEmbedding &E, const SList< adjEntry > &crossedEdges)
Re-inserts edge eOrig by "crossing" the edges in crossedEdges in embedding E. More...

void insertEdgePathEmbedded (edge eOrig, CombinatorialEmbedding &E, DynamicDualGraph &dual, const SList< adjEntry > &crossedEdges)

void removeEdgePathEmbedded (CombinatorialEmbedding &E, edge eOrig, FaceSet< false > &newFaces)
Removes the complete edge path for edge eOrig while preserving the embedding. More...

void removeEdgePathEmbedded (CombinatorialEmbedding &E, DynamicDualGraph &dual, edge eOrig)

void init (const Graph &G)
Re-initializes the copy using the graph G. More...

void createEmpty (const Graph &G)
Associates the graph copy with G, but does not create any nodes or edges. More...

void initByCC (const CCsInfo &info, int cc, EdgeArray< edge > &eCopy)
Initializes the graph copy for the nodes in component cc. More...

void initByNodes (const List< node > &origNodes, EdgeArray< edge > &eCopy)
Initializes the graph copy for the nodes in a component. More...

void initByActiveNodes (const List< node > &nodeList, const NodeArray< bool > &activeNodes, EdgeArray< edge > &eCopy)
Initializes the graph copy for the nodes in nodeList. More...

GraphCopyoperator= (const GraphCopy &GC)
Assignment operator. More...

Public Member Functions inherited from ogdf::Graph
bool empty () const
Returns true iff the graph is empty, i.e., contains no nodes. More...

int numberOfNodes () const
Returns the number of nodes in the graph. More...

int numberOfEdges () const
Returns the number of edges in the graph. More...

int maxNodeIndex () const
Returns the largest used node index. More...

int maxEdgeIndex () const
Returns the largest used edge index. More...

Returns the largest used adjEntry index. More...

int nodeArrayTableSize () const
Returns the table size of node arrays associated with this graph. More...

int edgeArrayTableSize () const
Returns the table size of edge arrays associated with this graph. More...

Returns the table size of adjEntry arrays associated with this graph. More...

node firstNode () const
Returns the first node in the list of all nodes. More...

node lastNode () const
Returns the last node in the list of all nodes. More...

edge firstEdge () const
Returns the first edge in the list of all edges. More...

edge lastEdge () const
Returns the last edge in the list of all edges. More...

node chooseNode (std::function< bool(node)> includeNode=[](node) { return true;}, bool isFastTest=true) const
Returns a random node. More...

edge chooseEdge (std::function< bool(edge)> includeEdge=[](edge) { return true;}, bool isFastTest=true) const
Returns a random edge. More...

template<class CONTAINER >
void allNodes (CONTAINER &nodeContainer) const
Returns a container with all nodes of the graph. More...

template<class CONTAINER >
void allEdges (CONTAINER &edgeContainer) const
Returns a container with all edges of the graph. More...

node newNode ()
Creates a new node and returns it. More...

node newNode (int index)
Creates a new node with predefined index and returns it. More...

edge newEdge (node v, node w)
Creates a new edge (v,w) and returns it. More...

edge newEdge (node v, node w, int index)
Creates a new edge (v,w) with predefined index and returns it. More...

Creates a new edge at predefined positions in the adjacency lists. More...

Creates a new edge at predefined positions in the adjacency lists. More...

Creates a new edge at predefined positions in the adjacency lists. More...

void insert (const Graph &G, NodeArray< node > &nodeMap)
Inserts Graph G as a subgraph into this Graph. More...

void insert (const Graph &G)
Inserts Graph G as a subgraph into this Graph. More...

void unsplit (node u)
Undoes a split operation. More...

Splits a node while preserving the order of adjacency entries. More...

node contract (edge e, bool keepSelfLoops=false)
Contracts edge e while preserving the order of adjacency entries. More...

Moves edge e to a different adjacency list. More...

void moveTarget (edge e, node w)
Moves the target node of edge e to node w. More...

Moves the target node of edge e to a specific position in an adjacency list. More...

void moveSource (edge e, node w)
Moves the source node of edge e to node w. More...

Moves the source node of edge e to a specific position in an adjacency list. More...

edge searchEdge (node v, node w, bool directed=false) const
Searches and returns an edge connecting nodes v and w in time O( min(deg(v ), deg(w ))). More...

void reverseEdge (edge e)
Reverses the edge e, i.e., exchanges source and target node. More...

void reverseAllEdges ()
Reverses all edges in the graph. More...

template<class NODELIST >
void collapse (NODELIST &nodesToCollapse)
Collapses all nodes in the list nodesToCollapse to the first node in the list. More...

void sort (node v, const ADJ_ENTRY_LIST &newOrder)
Sorts the adjacency list of node v according to newOrder. More...

Reverses the adjacency list of v. More...

Moves adjacency entry adjMove before or after adjPos. More...

Moves adjacency entry adjMove after adjAfter. More...

Moves adjacency entry adjMove before adjBefore. More...

Exchanges two entries in an adjacency list. More...

int genus () const
Returns the genus of the graph's embedding. More...

bool representsCombEmbedding () const
Returns true iff the graph represents a combinatorial embedding. More...

ListIterator< NodeArrayBase * > registerArray (NodeArrayBase *pNodeArray) const
Registers a node array. More...

ListIterator< EdgeArrayBase * > registerArray (EdgeArrayBase *pEdgeArray) const
Registers an edge array. More...

ListIterator< GraphObserver * > registerStructure (GraphObserver *pStructure) const
Registers a graph observer (e.g. a ClusterGraph). More...

void unregisterArray (ListIterator< NodeArrayBase * > it) const
Unregisters a node array. More...

void unregisterArray (ListIterator< EdgeArrayBase * > it) const
Unregisters an edge array. More...

void unregisterArray (ListIterator< AdjEntryArrayBase * > it) const

void unregisterStructure (ListIterator< GraphObserver * > it) const
Unregisters a graph observer. More...

template<class ArrayBase >
void moveRegisterArray (ListIterator< ArrayBase * > it, ArrayBase *pArray) const
Move the registration it of an graph element array to pArray (used with move semantics for graph element arrays). More...

void resetEdgeIdCount (int maxId)
Resets the edge id count to maxId. More...

Graph ()
Constructs an empty graph. More...

Graph (const Graph &G)
Constructs a graph that is a copy of G. More...

virtual ~Graph ()
Destructor. More...

Graphoperator= (const Graph &G)
Assignment operator. More...

## Degree-1 nodes

These methods realize a mechanism for temporarily removing degree-1 nodes.

int m_currentCC
The index of the current component. More...

Graph::CCsInfo m_ccInfo

const GraphAttributesm_pGraphAttributes
Pointer to graph attributes of original graph. More...

NodeArray< NodeTypem_vType
Simple node types. More...

NodeArray< nodeTypem_nodeTypes
Node types for extended semantic information. More...

NodeArray< nodem_expandedNode
For all expansion nodes, save expanded node. More...

EdgeArray< int > m_expansionEdge

EdgeArray< EdgeTypem_eType

EdgeArray< edgeTypem_edgeTypes

EdgeArray< edgeTypem_oriEdgeTypes

EdgeArray< edgem_eAuxCopy

void removeDeg1Nodes (ArrayBuffer< Deg1RestoreInfo > &S, const NodeArray< bool > &mark)
Removes all marked degree-1 nodes from the graph copy and stores restore information in S. More...

void restoreDeg1Nodes (ArrayBuffer< Deg1RestoreInfo > &S, List< node > &deg1s)
Restores degree-1 nodes previously removed with removeDeg1Nodes(). More...

void writeGML (const char *fileName, const OrthoRep &OR, const GridLayout &drawing)

void writeGML (std::ostream &os, const OrthoRep &OR, const GridLayout &drawing)

void setCopyType (edge eCopy, edge eOrig)

edgeType generalizationPattern () const

edgeType associationPattern () const

edgeType expansionPattern () const

edgeType assClassPattern () const

edgeType brotherPattern () const

edgeType halfBrotherPattern () const

edgeType cliquePattern () const

Public Types inherited from ogdf::Graph
enum  EdgeType { EdgeType::association = 0, EdgeType::generalization = 1, EdgeType::dependency = 2 }
The type of edges (only used in derived classes). More...

enum  NodeType { NodeType::vertex = 0, NodeType::dummy = 1, NodeType::generalizationMerger = 2, NodeType::generalizationExpander = 3, NodeType::highDegreeExpander = 4, NodeType::lowDegreeExpander = 5, NodeType::associationClass = 6 }
The type of nodes. More...

using node_iterator = internal::GraphIterator< node >
Provides a bidirectional iterator to a node in a graph. More...

using edge_iterator = internal::GraphIterator< edge >
Provides a bidirectional iterator to an edge in a graph. More...

Provides a bidirectional iterator to an entry in an adjacency list. More...

Public Attributes inherited from ogdf::Graph
internal::GraphObjectContainer< NodeElementnodes
The container containing all node objects. More...

internal::GraphObjectContainer< EdgeElementedges
The container containing all edge objects. More...

Protected Member Functions inherited from ogdf::GraphCopy

Removes the pseudo crossing that adj belongs to. More...

Removes the two crossings given by the adjEntries, assuming that both crossings stem from the same two edges. More...

Swaps the original edges from adjCopy1 up to the common node of {adjCopy1, adjCopy2} with the original edges from adjCopy2 up to the same common node. More...

Sets the original edges from adjCopy1 up to vCopy to eOrig2, and the original edges from adjCopy2 up to vCopy to eOrig1. More...

Protected Member Functions inherited from ogdf::Graph
void construct (const Graph &G, NodeArray< node > &mapNode, EdgeArray< edge > &mapEdge)

void assign (const Graph &G, NodeArray< node > &mapNode, EdgeArray< edge > &mapEdge)

void constructInitByNodes (const Graph &G, const List< node > &nodeList, NodeArray< node > &mapNode, EdgeArray< edge > &mapEdge)
Constructs a copy of the subgraph of G induced by nodeList. More...

void constructInitByActiveNodes (const List< node > &nodeList, const NodeArray< bool > &activeNodes, NodeArray< node > &mapNode, EdgeArray< edge > &mapEdge)

void constructInitByCC (const CCsInfo &info, int cc, NodeArray< node > &mapNode, EdgeArray< edge > &mapEdge)
Constructs a copy of connected component cc in info. More...

Protected Attributes inherited from ogdf::GraphCopy
EdgeArray< List< edge > > m_eCopy
The corresponding list of edges in the graph copy. More...

EdgeArray< ListIterator< edge > > m_eIterator
The position of copy edge in the list. More...

EdgeArray< edgem_eOrig
The corresponding edge in the original graph. More...

const Graphm_pGraph
The original graph. More...

NodeArray< nodem_vCopy
The corresponding node in the graph copy. More...

NodeArray< nodem_vOrig
The corresponding node in the original graph. 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 59 of file PlanRep.h.

## ◆ PlanRep() [1/2]

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

Creates a planarized representation of graph G.

## ◆ PlanRep() [2/2]

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

Creates a planarized representation of graph AG.

## ◆ ~PlanRep()

 virtual ogdf::PlanRep::~PlanRep ( )
inlinevirtual

Definition at line 82 of file PlanRep.h.

## ◆ assClassPattern()

 edgeType ogdf::PlanRep::assClassPattern ( ) const
inlineprotected

Definition at line 732 of file PlanRep.h.

## ◆ associationPattern()

 edgeType ogdf::PlanRep::associationPattern ( ) const
inlineprotected

Definition at line 730 of file PlanRep.h.

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 185 of file PlanRep.h.

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 177 of file PlanRep.h.

## ◆ brotherPattern()

 edgeType ogdf::PlanRep::brotherPattern ( ) const
inlineprotected

Definition at line 733 of file PlanRep.h.

## ◆ ccInfo()

 const CCsInfo& ogdf::PlanRep::ccInfo ( ) const
inline

Returns the connected components info structure.

Definition at line 104 of file PlanRep.h.

## ◆ cliquePattern()

 edgeType ogdf::PlanRep::cliquePattern ( ) const
inlineprotected

Definition at line 735 of file PlanRep.h.

## ◆ collapseVertices() [1/2]

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

## ◆ collapseVertices() [2/2]

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

## ◆ currentCC()

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

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

Definition at line 99 of file PlanRep.h.

## ◆ e()

 edge ogdf::PlanRep::e ( int i ) const
inline

Returns edge i in the list of all original edges.

Definition at line 118 of file PlanRep.h.

## ◆ edgeTypeAND()

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

Sets type of edge e to current type (bitwise) AND et.

Definition at line 445 of file PlanRep.h.

## ◆ edgeTypeOf()

 edgeType ogdf::PlanRep::edgeTypeOf ( edge e ) const
inline

Returns the new type field of e.

Parameters
 e is an edge in the planarized representation.

Definition at line 296 of file PlanRep.h.

## ◆ edgeTypeOR()

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

Sets type of edge e to current type (bitwise) OR et.

Definition at line 448 of file PlanRep.h.

## ◆ edgeTypePrimaryAND()

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

Sets primary type of e to bitwise AND of et's primary value and old value.

Definition at line 468 of file PlanRep.h.

## ◆ edgeTypePrimaryOR()

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

Sets primary type of e to bitwise OR of et's primary value and old value.

Definition at line 471 of file PlanRep.h.

## ◆ edgeTypes()

 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 305 of file PlanRep.h.

## ◆ expand()

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

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

inline

Definition at line 163 of file PlanRep.h.

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 159 of file PlanRep.h.

## ◆ expandedNode()

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

Definition at line 597 of file PlanRep.h.

## ◆ expandLowDegreeVertices()

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

## ◆ expansionPattern()

 edgeType ogdf::PlanRep::expansionPattern ( ) const
inlineprotected

Definition at line 731 of file PlanRep.h.

## ◆ expansionType()

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

Returns the expansion edge type of e.

Definition at line 507 of file PlanRep.h.

## ◆ generalizationPattern()

 edgeType ogdf::PlanRep::generalizationPattern ( ) const
inlineprotected

Definition at line 729 of file PlanRep.h.

## ◆ getGraphAttributes()

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

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

Definition at line 560 of file PlanRep.h.

## ◆ halfBrotherPattern()

 edgeType ogdf::PlanRep::halfBrotherPattern ( ) const
inlineprotected

Definition at line 734 of file PlanRep.h.

## ◆ heightOrig() [1/2]

 const NodeArray& ogdf::PlanRep::heightOrig ( ) const
inline

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

Definition at line 542 of file PlanRep.h.

## ◆ heightOrig() [2/2]

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

Returns the height of original node v.

Definition at line 548 of file PlanRep.h.

## ◆ initCC()

 void ogdf::PlanRep::initCC ( int cc )

Initializes the planarized representation for connected component cc.

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

## ◆ insertCrossing()

 edge ogdf::PlanRep::insertCrossing ( edge & crossingEdge, edge crossedEdge, bool topDown )

Inserts crossings between two copy edges.

This method is used in TopologyModule.

Let crossingEdge = (a, b) and crossedEdge = (v, w). Then crossedEdge is split creating two edges crossedEdge = (v, u) and (u, w), crossingEdge is removed and replaced by two new edges e1 = (a, u) and e1 = (u, b). Finally it sets crossingEdge to e2 and returns (u, w).

Parameters
 crossingEdge is the edge that gets split. crossedEdge is the edge that is replaced by two new edges. topDown is used as follows: If set to true, crossingEdge will cross crossedEdge from right to left, otherwise from left to right.

## ◆ insertEdgePath()

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

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

Splits each edge in crossedEdges.

Precondition
eOrig is an edge in the original graph and the edges in crossedEdges are in this graph.

## ◆ insertEdgePathEmbedded()

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

Same as insertEdgePath, but for embedded graphs.

## ◆ isAssClass()

 bool ogdf::PlanRep::isAssClass ( edge e ) const
inline

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

Definition at line 415 of file PlanRep.h.

## ◆ isBoundary()

 bool ogdf::PlanRep::isBoundary ( edge e ) const
inline

Returns true iff edge e is a clique boundary.

Definition at line 402 of file PlanRep.h.

## ◆ isBrother()

 bool ogdf::PlanRep::isBrother ( edge e ) const
inline

Returns true if edge e is classified as brother.

Definition at line 433 of file PlanRep.h.

## ◆ isCliqueBoundary()

 bool ogdf::PlanRep::isCliqueBoundary ( edge e ) const
inline

Definition at line 193 of file PlanRep.h.

## ◆ isCrossingType()

 bool ogdf::PlanRep::isCrossingType ( node v ) const
inline

Returns true iff node v is classified as a crossing.

Parameters
 v is a node in the planarized representation.

Definition at line 256 of file PlanRep.h.

## ◆ isDegreeExpansionEdge()

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

Returns if e is a degree expansion edge.

Definition at line 511 of file PlanRep.h.

## ◆ isDependency()

 bool ogdf::PlanRep::isDependency ( edge e ) const
inline

Returns true iff edge e is classified as dependency.

Definition at line 361 of file PlanRep.h.

## ◆ isExpansion()

 bool ogdf::PlanRep::isExpansion ( edge e ) const
inline

Returns true iff edge e is classified as expansion edge.

Definition at line 395 of file PlanRep.h.

## ◆ isExpansionEdge()

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

Returns if e is an expansion edge.

Definition at line 502 of file PlanRep.h.

## ◆ isGeneralization()

 bool ogdf::PlanRep::isGeneralization ( edge e ) const
inline

Returns true iff edge e is classified as generalization.

Definition at line 347 of file PlanRep.h.

## ◆ isHalfBrother()

 bool ogdf::PlanRep::isHalfBrother ( edge e ) const
inline

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

Definition at line 438 of file PlanRep.h.

## ◆ isUserType()

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

Returns user defined type.

Definition at line 481 of file PlanRep.h.

## ◆ isVertex()

 bool ogdf::PlanRep::isVertex ( node v ) const
inline

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

Definition at line 228 of file PlanRep.h.

## ◆ newCopy() [1/3]

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.

## ◆ newCopy() [2/3]

 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.

## ◆ newCopy() [3/3]

 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.

## ◆ nodeTypeOf()

 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 238 of file PlanRep.h.

## ◆ numberOfCCs()

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

Returns the number of connected components in the original graph.

Definition at line 94 of file PlanRep.h.

## ◆ numberOfNodesInCC() [1/2]

 int ogdf::PlanRep::numberOfNodesInCC ( ) const
inline

Returns the number of nodes in the current connected component.

Definition at line 107 of file PlanRep.h.

## ◆ numberOfNodesInCC() [2/2]

 int ogdf::PlanRep::numberOfNodesInCC ( int cc ) const
inline

Returns the number of nodes in connected component cc.

Definition at line 110 of file PlanRep.h.

## ◆ oriEdgeTypes()

 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 287 of file PlanRep.h.

## ◆ removeCrossing()

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

## ◆ removeDeg1Nodes()

 void ogdf::PlanRep::removeDeg1Nodes ( ArrayBuffer< Deg1RestoreInfo > & S, const NodeArray< bool > & mark )

Removes all marked degree-1 nodes from the graph copy and stores restore information in S.

Parameters
 S returns the restore information required by restoreDeg1Nodes(). mark defines which nodes are marked for removal; all nodes v with mark[a]=true are removed.
Precondition
Only nodes with degree 1 may be marked.

## ◆ removeEdgePathEmbedded()

 void ogdf::PlanRep::removeEdgePathEmbedded ( CombinatorialEmbedding & E, edge eOrig, FaceSet< false > & newFaces )
inline

Removes the complete edge path for edge eOrig while preserving the embedding.

Precondition
eOrig s an edge in the original graph.

Definition at line 659 of file PlanRep.h.

## ◆ restoreDeg1Nodes()

 void ogdf::PlanRep::restoreDeg1Nodes ( ArrayBuffer< Deg1RestoreInfo > & S, List< node > & deg1s )

Restores degree-1 nodes previously removed with removeDeg1Nodes().

Parameters
 S contains the restore information. deg1s returns the list of newly created nodes in the copy.

## ◆ setAssClass()

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

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

Definition at line 409 of file PlanRep.h.

## ◆ setAssociation()

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

Classifies edge e as association (primary type).

Definition at line 375 of file PlanRep.h.

## ◆ setBrother()

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

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

Definition at line 423 of file PlanRep.h.

## ◆ setCliqueBoundary()

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

Definition at line 190 of file PlanRep.h.

## ◆ setCopyType()

 void ogdf::PlanRep::setCopyType ( edge eCopy, edge eOrig )
protected

## ◆ setCrossingType()

 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 247 of file PlanRep.h.

## ◆ setDependency()

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

Classifies edge e as dependency (primary type).

Definition at line 367 of file PlanRep.h.

## ◆ setEdgeTypeOf()

 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 315 of file PlanRep.h.

## ◆ setExpandedNode()

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

Definition at line 599 of file PlanRep.h.

## ◆ setExpansion()

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

Classifies edge e as expansion edge (secondary type).

Definition at line 387 of file PlanRep.h.

## ◆ setExpansionEdge()

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

Sets the expansion edge type of e to expType.

Definition at line 497 of file PlanRep.h.

## ◆ setGeneralization()

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

Classifies edge e as generalization (primary type).

Definition at line 353 of file PlanRep.h.

## ◆ setHalfBrother()

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

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

Definition at line 428 of file PlanRep.h.

## ◆ setPrimaryType() [1/2]

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

Sets primary edge type of edge e to primary edge type in et (deletes old primary value).

Definition at line 451 of file PlanRep.h.

## ◆ setPrimaryType() [2/2]

 void ogdf::PlanRep::setPrimaryType ( edge e, UMLEdgeTypeConstants et )
inline

Sets primary edge type of edge e to primary edge type in et (deletes old primary value).

Definition at line 457 of file PlanRep.h.

## ◆ setSecondaryType()

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

Sets secondary edge type of edge e to primary edge type in et.

Definition at line 462 of file PlanRep.h.

## ◆ setType()

 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 328 of file PlanRep.h.

## ◆ setUserType()

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

Sets user defined type locally.

Definition at line 474 of file PlanRep.h.

## ◆ split()

 virtual edge ogdf::PlanRep::split ( edge e )
overridevirtual

Splits edge e.

Reimplemented from ogdf::GraphCopy.

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

## ◆ startEdge()

 int ogdf::PlanRep::startEdge ( ) const
inline

Returns the index of the first edge in this connected component.

Definition at line 133 of file PlanRep.h.

## ◆ startNode() [1/2]

 int ogdf::PlanRep::startNode ( ) const
inline

Returns the index of the first node in this connected component.

Definition at line 121 of file PlanRep.h.

## ◆ startNode() [2/2]

 int ogdf::PlanRep::startNode ( int cc ) const
inline

Returns the index of the first node in connected component cc.

Definition at line 124 of file PlanRep.h.

## ◆ stopEdge()

 int ogdf::PlanRep::stopEdge ( ) const
inline

Returns the index of (one past) the last edge in this connected component.

Definition at line 136 of file PlanRep.h.

## ◆ stopNode() [1/2]

 int ogdf::PlanRep::stopNode ( ) const
inline

Returns the index of (one past) the last node in this connected component.

Definition at line 127 of file PlanRep.h.

## ◆ stopNode() [2/2]

 int ogdf::PlanRep::stopNode ( int cc ) const
inline

Returns the index of (one past) the last node in connected component cc.

Definition at line 130 of file PlanRep.h.

## ◆ typeOf() [1/4]

 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 279 of file PlanRep.h.

## ◆ typeOf() [2/4]

 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 271 of file PlanRep.h.

## ◆ typeOf() [3/4]

 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 216 of file PlanRep.h.

## ◆ typeOf() [4/4]

 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 208 of file PlanRep.h.

## ◆ typeOrig()

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

Returns the type of original edge e.

Definition at line 554 of file PlanRep.h.

## ◆ v()

 node ogdf::PlanRep::v ( int i ) const
inline

Returns node i in the list of all original nodes.

Definition at line 115 of file PlanRep.h.

## ◆ widthOrig() [1/2]

 const NodeArray& ogdf::PlanRep::widthOrig ( ) const
inline

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

Definition at line 530 of file PlanRep.h.

## ◆ widthOrig() [2/2]

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

Returns the width of original node v.

Definition at line 536 of file PlanRep.h.

## ◆ writeGML() [1/2]

 void ogdf::PlanRep::writeGML ( const char * fileName, const OrthoRep & OR, const GridLayout & drawing )

## ◆ writeGML() [2/2]

 void ogdf::PlanRep::writeGML ( std::ostream & os, const OrthoRep & OR, const GridLayout & drawing )

## Member Data Documentation

protected

Definition at line 746 of file PlanRep.h.

## ◆ m_ccInfo

 Graph::CCsInfo ogdf::PlanRep::m_ccInfo
protected

Definition at line 715 of file PlanRep.h.

## ◆ m_currentCC

 int ogdf::PlanRep::m_currentCC
protected

The index of the current component.

Definition at line 714 of file PlanRep.h.

## ◆ m_eAuxCopy

 EdgeArray ogdf::PlanRep::m_eAuxCopy
protected

Definition at line 765 of file PlanRep.h.

## ◆ m_edgeTypes

 EdgeArray ogdf::PlanRep::m_edgeTypes
protected

Definition at line 758 of file PlanRep.h.

## ◆ m_eType

 EdgeArray ogdf::PlanRep::m_eType
protected

Definition at line 750 of file PlanRep.h.

protected

Definition at line 742 of file PlanRep.h.

## ◆ m_expandedNode

 NodeArray ogdf::PlanRep::m_expandedNode
protected

For all expansion nodes, save expanded node.

Definition at line 741 of file PlanRep.h.

## ◆ m_expansionEdge

 EdgeArray ogdf::PlanRep::m_expansionEdge
protected

Definition at line 749 of file PlanRep.h.

## ◆ m_nodeTypes

 NodeArray ogdf::PlanRep::m_nodeTypes
protected

Node types for extended semantic information.

Definition at line 739 of file PlanRep.h.

## ◆ m_oriEdgeTypes

 EdgeArray ogdf::PlanRep::m_oriEdgeTypes
protected

Definition at line 763 of file PlanRep.h.

## ◆ m_pGraphAttributes

 const GraphAttributes* ogdf::PlanRep::m_pGraphAttributes
protected

Pointer to graph attributes of original graph.

Definition at line 720 of file PlanRep.h.

## ◆ m_vType

 NodeArray ogdf::PlanRep::m_vType
protected

Simple node types.

Definition at line 737 of file PlanRep.h.

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