ext/OGDF/ogdf/internal/planarity/EmbedPQTree.h

   1 /*
   2  * $Revision: 2564 $
   3  *
   4  * last checkin:
   5  *   $Author: gutwenger $
   6  *   $Date: 2012-07-07 00:03:48 +0200 (Sa, 07. Jul 2012) $
   7  ***************************************************************/
   8
   9 /** \file
  10  * \brief Declaration of the class EmbedPQTree.
  11  *
  12  * \author Sebastian Leipert
  13  *
  14  * \par License:
  15  * This file is part of the Open Graph Drawing Framework (OGDF).
  16  *
  17  * \par
  18  * Copyright (C)<br>
  19  * See README.txt in the root directory of the OGDF installation for details.
  20  *
  21  * \par
  22  * This program is free software; you can redistribute it and/or
  23  * modify it under the terms of the GNU General Public License
  24  * Version 2 or 3 as published by the Free Software Foundation;
  25  * see the file LICENSE.txt included in the packaging of this file
  26  * for details.
  27  *
  28  * \par
  29  * This program is distributed in the hope that it will be useful,
  30  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  31  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  32  * GNU General Public License for more details.
  33  *
  34  * \par
  35  * You should have received a copy of the GNU General Public
  36  * License along with this program; if not, write to the Free
  37  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  38  * Boston, MA 02110-1301, USA.
  39  *
  40  * \see  http://www.gnu.org/copyleft/gpl.html
  41  ***************************************************************/
  42
  43 #ifdef _MSC_VER
  44 #pragma once
  45 #endif
  46
  47
  48
  49 #ifndef OGDF_EMBED_PQTREE_H
  50 #define OGDF_EMBED_PQTREE_H
  51
  52 #include <ogdf/basic/Graph.h>
  53 #include <ogdf/basic/SList.h>
  54 #include <ogdf/internal/planarity/PQTree.h>
  55 #include <ogdf/internal/planarity/PlanarLeafKey.h>
  56 #include <ogdf/internal/planarity/EmbedIndicator.h>
  57
  58 namespace ogdf {
  59
  60 typedef PQBasicKey<edge,IndInfo*,bool> *PtrPQBasicKeyEIB;
  61
  62 template<>
  63 inline bool doDestruction<PtrPQBasicKeyEIB>(const PtrPQBasicKeyEIB*) { return false; }
  64
  65
  66 typedef PlanarLeafKey<IndInfo*> *PtrPlanarLeafKeyI;
  67
  68 template<>
  69 inline bool doDestruction<PtrPlanarLeafKeyI>(const PtrPlanarLeafKeyI*) { return false; }
  70
  71
  72 class EmbedPQTree: public PQTree<edge,IndInfo*,bool>
  73 {
  74 public:
  75
  76         EmbedPQTree() : PQTree<edge,IndInfo*,bool>() { }
  77
  78         virtual ~EmbedPQTree() { }
  79
  80         virtual void emptyAllPertinentNodes();
  81
  82         virtual void clientDefinedEmptyNode(PQNode<edge,IndInfo*,bool>* nodePtr);
  83
  84         virtual int Initialize(SListPure<PlanarLeafKey<IndInfo*>*> &leafKeys);
  85
  86         void ReplaceRoot(
  87                 SListPure<PlanarLeafKey<IndInfo*>*> &leafKeys,
  88                 SListPure<edge> &frontier,
  89                 SListPure<node> &opposed,
  90                 SListPure<node> &nonOpposed,
  91                 node v);
  92
  93         virtual bool Reduction(SListPure<PlanarLeafKey<IndInfo*>*> &leafKeys);
  94
  95         PQNode<edge,IndInfo*,bool>* scanSibLeft(PQNode<edge,IndInfo*,bool> *nodePtr) const {
  96                 return clientSibLeft(nodePtr);
  97         }
  98
  99         PQNode<edge,IndInfo*,bool>* scanSibRight(PQNode<edge,IndInfo*,bool> *nodePtr) const {
 100                 return clientSibRight(nodePtr);
 101         }
 102
 103         PQNode<edge,IndInfo*,bool>* scanLeftEndmost(PQNode<edge,IndInfo*,bool> *nodePtr) const {
 104                 return clientLeftEndmost(nodePtr);
 105         }
 106
 107         PQNode<edge,IndInfo*,bool>* scanRightEndmost(PQNode<edge,IndInfo*,bool> *nodePtr) const {
 108                 return clientRightEndmost(nodePtr);
 109         }
 110
 111         PQNode<edge,IndInfo*,bool>* scanNextSib(
 112                 PQNode<edge,IndInfo*,bool> *nodePtr,
 113                 PQNode<edge,IndInfo*,bool> *other) {
 114                         return clientNextSib(nodePtr,other);
 115         }
 116
 117         virtual void getFront(
 118                 PQNode<edge,IndInfo*,bool>* nodePtr,
 119                 SListPure<PQBasicKey<edge,IndInfo*,bool>*> &leafKeys);
 120
 121 protected:
 122
 123         virtual PQNode<edge,IndInfo*,bool>*
 124                 clientSibLeft(PQNode<edge,IndInfo*,bool> *nodePtr) const;
 125
 126         virtual PQNode<edge,IndInfo*,bool>*
 127                 clientSibRight(PQNode<edge,IndInfo*,bool> *nodePtr) const;
 128
 129         virtual PQNode<edge,IndInfo*,bool>*
 130                 clientLeftEndmost(PQNode<edge,IndInfo*,bool> *nodePtr) const;
 131
 132         virtual PQNode<edge,IndInfo*,bool>*
 133                 clientRightEndmost(PQNode<edge,IndInfo*,bool> *nodePtr) const;
 134
 135         virtual PQNode<edge,IndInfo*,bool>*
 136                 clientNextSib(PQNode<edge,IndInfo*,bool> *nodePtr,
 137                 PQNode<edge,IndInfo*,bool> *other) const;
 138         virtual const char*
 139                 clientPrintStatus(PQNode<edge,IndInfo*,bool> *nodePtr);
 140
 141         virtual void front(
 142                 PQNode<edge,IndInfo*,bool>* nodePtr,
 143                 SListPure<PQBasicKey<edge,IndInfo*,bool>*> &leafKeys);
 144
 145 private:
 146
 147         void ReplaceFullRoot(
 148                 SListPure<PlanarLeafKey<IndInfo*>*> &leafKeys,
 149                 SListPure<PQBasicKey<edge,IndInfo*,bool>*> &frontier,
 150                 node v,
 151                 bool addIndicator = false,
 152                 PQNode<edge,IndInfo*,bool> *opposite = 0);
 153
 154         void ReplacePartialRoot(
 155                 SListPure<PlanarLeafKey<IndInfo*>*> &leafKeys,
 156                 SListPure<PQBasicKey<edge,IndInfo*,bool>*> &frontier,
 157                 node v);
 158 };
 159
 160 }
 161
 162 #endif