Open
Graph Drawing
Framework

  v.2012.07
 
Overview Class Hierarchy Class Index Class List Members Namespaces Source Files

Public Member Functions
ogdf::EmbedIndicator Class Reference

#include <ogdf/internal/planarity/EmbedIndicator.h>

+ Inheritance diagram for ogdf::EmbedIndicator:

List of all members.

Public Member Functions

 EmbedIndicator (int count, PQNodeKey< edge, IndInfo *, bool > *infoPtr)
virtual ~EmbedIndicator ()
PQInternalKey< edge, IndInfo
*, bool > * 		getInternal () const
PQLeafKey< edge, IndInfo
*, bool > * 		getKey () const
PQNodeMark mark () const
void mark (PQNodeMark)
 mark() sets the variable m_mark in the derived class PQLeaf and PQInternalNode.
bool setInternal (PQInternalKey< edge, IndInfo *, bool > *pointerToInternal)
bool setKey (PQLeafKey< edge, IndInfo *, bool > *pointerToKey)
 Sets a specified pointer variable in a derived class to the specified adress of pointerToKey that is of type PQLeafKey.
PQNodeStatus status () const
 Returns the variable m_status in the derived class PQLeaf and PQInternalNode.
void status (PQNodeStatus)
 Sets the variable m_status in the derived class PQLeaf and PQInternalNode.
PQNodeType type () const
 Returns the variable m_type in the derived class PQLeaf and PQInternalNode.
void type (PQNodeType)
 Sets the variable m_type in the derived class PQLeaf and PQInternalNode.
- Public Member Functions inherited from ogdf::PQNode< edge, IndInfo *, bool >
 PQNode (int count, PQNodeKey< edge, IndInfo *, bool > *infoPtr)
 PQNode (int count)
virtual ~PQNode ()
bool changeEndmost (PQNode< edge, IndInfo *, bool > *oldEnd, PQNode< edge, IndInfo *, bool > *newEnd)
bool changeSiblings (PQNode< edge, IndInfo *, bool > *oldSib, PQNode< edge, IndInfo *, bool > *newSib)
int childCount () const
 Returns the number of children of a node.
void childCount (int count)
 Sets the number of children of a node.
bool endmostChild ()
PQNode< edge, IndInfo *, bool > * getEndmost (PQNode< edge, IndInfo *, bool > *other) const
PQNode< edge, IndInfo *, bool > * getEndmost (int side) const
PQNode< edge, IndInfo *, bool > * getNextSib (PQNode< edge, IndInfo *, bool > *other) const
PQNodeKey< edge, IndInfo
*, bool > * 		getNodeInfo () const
 Returns the identification number of a node.
PQNode< edge, IndInfo *, bool > * getSib (int side) const
int identificationNumber () const
 Returns the identification number of a node.
PQNode< edge, IndInfo *, bool > * parent () const
PQNode< edge, IndInfo *, bool > * parent (PQNode< edge, IndInfo *, bool > *newParent)
int parentType () const
 Returns the type of the parent of a node.
void parentType (int newParentType)
int pertChildCount () const
 Returs the number of pertinent children of a node.
void pertChildCount (int count)
 Sets the number of pertinent children of a node.
SibDirection putSibling (PQNode< edge, IndInfo *, bool > *newSib)
SibDirection putSibling (PQNode< edge, IndInfo *, bool > *newSib, int preference)
PQNode< edge, IndInfo *, bool > * referenceChild () const
 Returns a pointer to the reference child if node is a P-node.
PQNode< edge, IndInfo *, bool > * referenceParent () const
 Returns the pointer to the parent if node is a reference child.
bool setNodeInfo (PQNodeKey< edge, IndInfo *, bool > *pointerToInfo)
 Sets the pointer m_pointerToInfo to the specified adress of pointerToInfo.
- Public Member Functions inherited from ogdf::PQNodeRoot
 PQNodeRoot ()
virtual ~PQNodeRoot ()

Additional Inherited Members

- Protected Attributes inherited from ogdf::PQNode< edge, IndInfo *, bool >
List< PQNode< edge, IndInfo
*, bool > * > * 		fullChildren
 Stores all full children of a node during a reduction.
int m_childCount
int m_debugTreeNumber
PQNode< edge, IndInfo *, bool > * m_firstFull
 Stores a pointer to the first full child of a Q-node.
int m_identificationNumber
PQNode< edge, IndInfo *, bool > * m_leftEndmost
PQNode< edge, IndInfo *, bool > * m_parent
int m_parentType
 Stores the type of the parent which can be either a P- or Q-node.
int m_pertChildCount
 Stores the number of pertinent children of the node.
int m_pertLeafCount
 Stores the number of pertinent leaves in the frontier of the node.
PQNodeKey< edge, IndInfo
*, bool > * 		m_pointerToInfo
 Stores a pointer to the corresponding information of the node.
PQNode< edge, IndInfo *, bool > * m_referenceChild
PQNode< edge, IndInfo *, bool > * m_referenceParent
PQNode< edge, IndInfo *, bool > * m_rightEndmost
 Stores the right endmost child of a Q-node.
PQNode< edge, IndInfo *, bool > * m_sibLeft
PQNode< edge, IndInfo *, bool > * m_sibRight
List< PQNode< edge, IndInfo
*, bool > * > * 		partialChildren
 Stores all partial children of a node during a reduction.

Detailed Description

Definition at line 64 of file EmbedIndicator.h.

Constructor & Destructor Documentation

ogdf::EmbedIndicator::EmbedIndicator ( int  count,
PQNodeKey< edge, IndInfo *, bool > *  infoPtr 
)
inline

Definition at line 68 of file EmbedIndicator.h.

virtual ogdf::EmbedIndicator::~EmbedIndicator ( )
inlinevirtual

Definition at line 71 of file EmbedIndicator.h.

Member Function Documentation

PQInternalKey<edge,IndInfo*,bool>* ogdf::EmbedIndicator::getInternal ( ) const
inlinevirtual

getInternal() returns a pointer to the PQInternalKey information of a node, in case that the node is supposed to have PQInternalKey information, such as elements of the derived class template PQInternalNode. The internal information is of type PQInternalKey.

Implements ogdf::PQNode< edge, IndInfo *, bool >.

Definition at line 94 of file EmbedIndicator.h.

PQLeafKey<edge,IndInfo*,bool>* ogdf::EmbedIndicator::getKey ( ) const
inlinevirtual

getKey() returns a pointer to the PQLeafKeyof a node, in case that the node is supposed to have a key, such as elements of the derived class template PQLeaf. The key contains information and is of type PQLeafKey.

Implements ogdf::PQNode< edge, IndInfo *, bool >.

Definition at line 88 of file EmbedIndicator.h.

PQNodeMark ogdf::EmbedIndicator::mark ( ) const
inlinevirtual

mark() returns the variable m_mark in the derived class PQLeaf and PQInternalNode. In a derived class this function has to return the designation used in the first pass of Booth and Luekers algorithm called Bubble(). A node then is either marked BLOCKED, UNBLOCKED or QUEUED (see PQNode).

Implements ogdf::PQNode< edge, IndInfo *, bool >.

Definition at line 84 of file EmbedIndicator.h.

void ogdf::EmbedIndicator::mark ( PQNodeMark  )
inlinevirtual

mark() sets the variable m_mark in the derived class PQLeaf and PQInternalNode.

Implements ogdf::PQNode< edge, IndInfo *, bool >.

Definition at line 86 of file EmbedIndicator.h.

bool ogdf::EmbedIndicator::setInternal ( PQInternalKey< edge, IndInfo *, bool > *  pointerToInternal)
inlinevirtual

Implements ogdf::PQNode< edge, IndInfo *, bool >.

Definition at line 96 of file EmbedIndicator.h.

bool ogdf::EmbedIndicator::setKey ( PQLeafKey< edge, IndInfo *, bool > *  pointerToKey)
inlinevirtual

Sets a specified pointer variable in a derived class to the specified adress of pointerToKey that is of type PQLeafKey.

If a derived class, such as PQInternalNode, is not supposed to store informations of type PQLeafKey, setKey() ignores the informations as long as pointerToKey = 0. The return value then is 1. In case that pointerToKey != 0, the return value is 0.

If a derived class, such as PQLeaf is supposed to store informations of type PQLeafKey, pointerToKey has to be instantiated by the client. The function setKey() does not instantiate the corresponding variable in the derived class. The return value is always 1 unless pointerKey was equal to 0.

Implements ogdf::PQNode< edge, IndInfo *, bool >.

Definition at line 90 of file EmbedIndicator.h.

PQNodeStatus ogdf::EmbedIndicator::status ( ) const
inlinevirtual

Returns the variable m_status in the derived class PQLeaf and PQInternalNode.

Its objective is to manage status of a node in the PQ-tree. A status is any kind of information of the current situation in the frontier of a node (the frontier of a node are all descendant leaves of the node). A status is anything such as EMPTY, FULL or PARTIAL (see PQNode). Since there might be more than those three possibilities, (e.g. in computing planar subgraphs this function probably has to be overloaded by the client.

Implements ogdf::PQNode< edge, IndInfo *, bool >.

Definition at line 80 of file EmbedIndicator.h.

void ogdf::EmbedIndicator::status ( PQNodeStatus  )
inlinevirtual

Sets the variable m_status in the derived class PQLeaf and PQInternalNode.

Implements ogdf::PQNode< edge, IndInfo *, bool >.

Definition at line 82 of file EmbedIndicator.h.

PQNodeType ogdf::EmbedIndicator::type ( ) const
inlinevirtual

Returns the variable m_type in the derived class PQLeaf and PQInternalNode.

Its objective it to manage the type of a node. node the current node is. The type of a node in the class template PQTree is either PNode, QNode or leaf (see PQNode). There may be of course more types such as sequence indicators.

Observe that the derived class template PQLeaf does not have a variable m_type, since it obviously is of type leaf.

Implements ogdf::PQNode< edge, IndInfo *, bool >.

Definition at line 76 of file EmbedIndicator.h.

void ogdf::EmbedIndicator::type ( PQNodeType  )
inlinevirtual

Sets the variable m_type in the derived class PQLeaf and PQInternalNode.

Implements ogdf::PQNode< edge, IndInfo *, bool >.

Definition at line 78 of file EmbedIndicator.h.

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