ext/OGDF/ogdf/augmentation/PlanarAugmentationFix.h

   1 /*
   2  * $Revision: 2523 $
   3  *
   4  * last checkin:
   5  *   $Author: gutwenger $
   6  *   $Date: 2012-07-02 20:59:27 +0200 (Mon, 02 Jul 2012) $
   7  ***************************************************************/
   8
   9 /** \file
  10  * \brief planar biconnected augmentation algorithm with fixed
  11  *                combinatorial embedding.
  12  *
  13  * \author Bernd Zey
  14  *
  15  * \par License:
  16  * This file is part of the Open Graph Drawing Framework (OGDF).
  17  *
  18  * \par
  19  * Copyright (C)<br>
  20  * See README.txt in the root directory of the OGDF installation for details.
  21  *
  22  * \par
  23  * This program is free software; you can redistribute it and/or
  24  * modify it under the terms of the GNU General Public License
  25  * Version 2 or 3 as published by the Free Software Foundation;
  26  * see the file LICENSE.txt included in the packaging of this file
  27  * for details.
  28  *
  29  * \par
  30  * This program is distributed in the hope that it will be useful,
  31  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  32  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  33  * GNU General Public License for more details.
  34  *
  35  * \par
  36  * You should have received a copy of the GNU General Public
  37  * License along with this program; if not, write to the Free
  38  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  39  * Boston, MA 02110-1301, USA.
  40  *
  41  * \see  http://www.gnu.org/copyleft/gpl.html
  42  ***************************************************************/
  43
  44 #ifdef _MSC_VER
  45 #pragma once
  46 #endif
  47
  48 #ifndef OGDF_PLANAR_AUGMENTATION_FIX_H
  49 #define OGDF_PLANAR_AUGMENTATION_FIX_H
  50
  51 #include <ogdf/module/AugmentationModule.h>
  52 #include <ogdf/basic/GraphCopy.h>
  53 #include <ogdf/internal/augmentation/PALabel.h>
  54
  55
  56 namespace ogdf {
  57
  58         class DynamicBCTree;
  59
  60
  61 /**
  62  * \brief The algorithm for biconnectivity augmentation with fixed combinatorial embedding.
  63  *
  64  */
  65 class OGDF_EXPORT PlanarAugmentationFix : public AugmentationModule {
  66
  67 public:
  68         //! Creates an instance of planar augmentation with fixed embedding.
  69         PlanarAugmentationFix() { }
  70
  71         ~PlanarAugmentationFix() { }
  72
  73
  74 protected:
  75         /**
  76          * \brief The implementation of the algorithm call.
  77          *
  78          * \param g is the working graph.
  79          * \param L is the list of all new edges.
  80          */
  81         void doCall(Graph& g, List<edge>& L);
  82
  83 private:
  84         /**
  85          * \brief The embedding of g.
  86          */
  87         CombinatorialEmbedding* m_pEmbedding;
  88
  89         /**
  90          * \brief The embedding of the actual partial graph.
  91          */
  92         CombinatorialEmbedding* m_pActEmbedding;
  93
  94         /**
  95          * \brief The working graph.
  96          */
  97         Graph* m_pGraph;
  98
  99         /**
 100          * \brief The inserted edges by the algorithm.
 101          */
 102         List<edge>* m_pResult;
 103
 104         /**
 105          * \brief The actual dynamic bc-tree.
 106          */
 107         DynamicBCTree* m_pBCTree;
 108
 109         /**
 110          * \brief The actual partial graph.
 111          */
 112         GraphCopy m_graphCopy;
 113
 114         /**
 115          * \brief Edge-array required for construction of the graph copy.
 116          */
 117         EdgeArray<edge> m_eCopy;
 118
 119         /**
 120          * \brief The list of all labels.
 121          */
 122         List<pa_label> m_labels;
 123
 124         /**
 125          * \brief Array that contains iterators to the list of labels
 126          *               if a node is a parent of a label.
 127          */
 128         NodeArray< ListIterator<pa_label> > m_isLabel;
 129
 130         /**
 131          * \brief Array that contains the label a node belongs to.
 132          */
 133         NodeArray<pa_label> m_belongsTo;
 134
 135         /**
 136          * \brief Array that contains the iterator of the label a node belongs to.
 137          */
 138         NodeArray< ListIterator<node> > m_belongsToIt;
 139
 140         /**
 141          * \brief The actual root of the bc-tree.
 142          */
 143         node m_actBCRoot;
 144
 145         /**
 146          * \brief The main function for planar augmentation.
 147          */
 148         void augment(adjEntry adjOuterFace);
 149
 150         /**
 151          * \brief Modifies the root of the bc-tree.
 152          */
 153         void modifyBCRoot(node oldRoot, node newRoot);
 154
 155         /**
 156          * \brief Exchanges oldRoot by newRoot and updates data structurs in the bc-tree.
 157          */
 158         void changeBCRoot(node oldRoot, node newRoot);
 159
 160         /**
 161          * \brief Adds the pendant to a label or creates one (uses followPath()).
 162          */
 163         void reduceChain(node pendant);
 164
 165         /**
 166          * \brief Traverses upwards in the bc-tree, starting at the pendant node.
 167          */
 168         paStopCause followPath(node v, node& last);
 169
 170         /**
 171          * \brief Finds the next matching pendants.
 172          */
 173         bool findMatching(node& pendant1, node& pendant2, adjEntry& v1, adjEntry& v2);
 174
 175         /**
 176          * \brief Called by findMatching, if a dominating tree was detected.
 177          */
 178         void findMatchingRev(node& pendant1, node& pendant2, adjEntry& v1, adjEntry& v2);
 179
 180         /**
 181          * \brief Creates a new label.
 182          */
 183         pa_label newLabel(node cutvertex, node parent, node pendant, paStopCause whyStop);
 184
 185         /**
 186          * \brief Adds pendant \a p to label \a l.
 187          */
 188         void addPendant(node p, pa_label& l);
 189
 190         /**
 191          * \brief Inserts the label into the list of labels maintaining decreasing order.
 192          */
 193         ListIterator<pa_label> insertLabel(pa_label l);
 194
 195         /**
 196          * \brief Connect the two pendants.
 197          */
 198         void connectPendants(node pendant1, node pendant2, adjEntry adjV1, adjEntry adjV2);
 199
 200         /**
 201          * \brief Connects the remaining label.
 202          */
 203         void connectSingleLabel();
 204
 205         /**
 206          * \brief Deletes the pendant.
 207          */
 208         void deletePendant(node pendant);
 209
 210         /**
 211          * \brief Deletes the label.
 212          */
 213         void deleteLabel(pa_label& l, bool removePendants = true);
 214
 215         /**
 216          * \brief Removes the label from the list of labels.
 217          */
 218         void removeLabel(pa_label& l);
 219
 220 };      // class PlanarAugmentationFix
 221
 222
 223 } // namespace ogdf
 224
 225 #endif