Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::PQNodeKey< T, X, Y > Class Template Reference

The class template PQNodeKey is a derived class of class template PQBasicKey. More...

#include <ogdf/basic/pqtree/PQNode.h>

Public Member Functions

 PQNodeKey (X info)
 
virtual ~PQNodeKey ()
 
virtual X userStructInfo ()
 Returns m_userStructInfo. More...
 
virtual Y userStructInternal ()
 Returns 0. More...
 
virtual T userStructKey ()
 Returns 0. More...
 

Public Attributes

m_userStructInfo
 Stores the information. Has to be overloaded by the client. More...
 

Detailed Description

template<class T, class X, class Y>
class ogdf::PQNodeKey< T, X, Y >

The class template PQNodeKey is a derived class of class template PQBasicKey.

PQNodeKey is a concrete class. It is constructed to store any kind of information of nodes of the PQ-tree. It may be used for both internal nodes as well as leaves.

The information is stored in m_userStructInfo and is assigned to a unique node in the PQ-tree. This unique node can be identified with the #m_nodePointer of the astract base class PQBasicKey. The maintainance of this pointer is left to the user. By keeping the responsibillity by the user, nodes with certain informations can be identified and accessed by her in constant time. This makes the adaption of algorithms fast and easy.

Definition at line 47 of file PQNode.h.

Constructor & Destructor Documentation

◆ PQNodeKey()

template<class T , class X , class Y >
ogdf::PQNodeKey< T, X, Y >::PQNodeKey ( info)
inlineexplicit

Definition at line 63 of file PQNodeKey.h.

◆ ~PQNodeKey()

template<class T , class X , class Y >
virtual ogdf::PQNodeKey< T, X, Y >::~PQNodeKey ( )
inlinevirtual

Definition at line 66 of file PQNodeKey.h.

Member Function Documentation

◆ userStructInfo()

template<class T , class X , class Y >
virtual X ogdf::PQNodeKey< T, X, Y >::userStructInfo ( )
inlinevirtual

Returns m_userStructInfo.

Definition at line 72 of file PQNodeKey.h.

◆ userStructInternal()

template<class T , class X , class Y >
virtual Y ogdf::PQNodeKey< T, X, Y >::userStructInternal ( )
inlinevirtual

Returns 0.

Definition at line 75 of file PQNodeKey.h.

◆ userStructKey()

template<class T , class X , class Y >
virtual T ogdf::PQNodeKey< T, X, Y >::userStructKey ( )
inlinevirtual

Returns 0.

Definition at line 69 of file PQNodeKey.h.

Member Data Documentation

◆ m_userStructInfo

template<class T , class X , class Y >
X ogdf::PQNodeKey< T, X, Y >::m_userStructInfo

Stores the information. Has to be overloaded by the client.

Definition at line 60 of file PQNodeKey.h.


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