ext/OGDF/ogdf/module/UpwardPlanarSubgraphModule.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 Declaration of interface for upward planar subgraph
  11  *        algorithms.
  12  *
  13  * \author Carsten Gutwenger
  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
  45 #ifdef _MSC_VER
  46 #pragma once
  47 #endif
  48
  49 #ifndef OGDF_UPWARD_PLANAR_SUBGRAPH_MODULE_H
  50 #define OGDF_UPWARD_PLANAR_SUBGRAPH_MODULE_H
  51
  52
  53
  54 #include <ogdf/basic/GraphCopy.h>
  55
  56
  57 namespace ogdf {
  58
  59 /**
  60  * \brief Interface for algorithms for computing an upward planar subgraph.
  61  */
  62 class OGDF_EXPORT UpwardPlanarSubgraphModule {
  63 public:
  64         //! Initializes an upward planar subgraph module.
  65         UpwardPlanarSubgraphModule() { }
  66
  67         // destruction
  68         virtual ~UpwardPlanarSubgraphModule() { }
  69
  70         /**
  71          * \brief Computes set of edges \a delEdges which have to be deleted to obtain the upward planar subgraph.
  72          *
  73          * Must be implemented by derived classes.
  74          * @param G is the input graph.
  75          * @param delEdges is assigned the set of edges which have to be deleted in \a G
  76          *        to obtain the upward planar subgraph.
  77          */
  78         virtual void call(const Graph &G, List<edge> &delEdges) = 0;
  79
  80
  81         //! Computes set of edges \a delEdges which have to be deleted to obtain the upward planar subgraph.
  82         void operator()(const Graph &G, List<edge> &delEdges) {
  83                 call(G,delEdges);
  84         }
  85
  86
  87         /**
  88          * \brief Makes \a GC upward planar by deleting edges.
  89          * @param GC is a copy of the input graph.
  90          * @param delOrigEdges is the set of original edges whose copies have been
  91          *        deleted in \a GC.
  92          */
  93         void callAndDelete(GraphCopy &GC, List<edge> &delOrigEdges);
  94
  95
  96
  97         OGDF_MALLOC_NEW_DELETE
  98 }; // class UpwardPlanarSubgraph
  99
 100
 101
 102 } // end namespace ogdf
 103
 104 #endif