ext/OGDF/ogdf/augmentation/DfsMakeBiconnected.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 Provides a simple, dfs-based algorithm for biconnectivity augmentation.
  11  *
  12  * \author Carsten Gutwenger
  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 #ifndef OGDF_DFS_MAKE_BICONNECTED_H
  48 #define OGDF_DFS_MAKE_BICONNECTED_H
  49
  50
  51
  52 #include <ogdf/module/AugmentationModule.h>
  53
  54 namespace ogdf {
  55
  56 /**
  57  * \brief Implementation of a DFS-based algorithm for biconnectivity augmentation.
  58  *
  59  * The class \a DfsMakeBiconnected implements an augmentation algorithms
  60  * that augments a graph to a biconnected graph. In addition, if the graph was
  61  * planar before augmentation, the resulting graph will be biconnected and
  62  * planar.
  63  * The algorithm simply uses DFS and, whenever a cut vertex is discovered,
  64  * a new edge is added.
  65  */
  66
  67 class OGDF_EXPORT DfsMakeBiconnected : public AugmentationModule {
  68 public:
  69         //! Creates an instance of DFS-based biconnectivity augmentation.
  70         DfsMakeBiconnected() { }
  71
  72         // destruction
  73         ~DfsMakeBiconnected() { }
  74
  75 protected:
  76         //! Implements the algorithm call.
  77         void doCall(Graph& G, List<edge> &L);
  78 };
  79
  80 } // end namespace ogdf
  81
  82 #endif