1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
|
/*
* $Revision: 2566 $
*
* last checkin:
* $Author: gutwenger $
* $Date: 2012-07-07 23:10:08 +0200 (Sat, 07 Jul 2012) $
***************************************************************/
/** \file
* \brief Declaration of Feasible Upward Planar Subgraph (FUPS) Module, an interface for subgraph computation.
*
* \author Hoi-Ming Wong
*
* \par License:
* This file is part of the Open Graph Drawing Framework (OGDF).
*
* \par
* Copyright (C)<br>
* See README.txt in the root directory of the OGDF installation for details.
*
* \par
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* Version 2 or 3 as published by the Free Software Foundation;
* see the file LICENSE.txt included in the packaging of this file
* for details.
*
* \par
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* \par
* You should have received a copy of the GNU General Public
* License along with this program; if not, write to the Free
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
* \see http://www.gnu.org/copyleft/gpl.html
***************************************************************/
#ifndef OGDF_FUPS_MODULE_H
#define OGDF_FUPS_MODULE_H
#include <ogdf/basic/Module.h>
#include <ogdf/upward/UpwardPlanRep.h>
namespace ogdf {
/**
* \brief Interface for feasible upward planar subgraph algorithms.
*
*/
class OGDF_EXPORT FUPSModule : public Module
{
public:
//! Initializes a feasible upward planar subgraph module.
FUPSModule() { }
// destruction
virtual ~FUPSModule() { }
/**
* \brief Computes a feasible upward planar subgraph of the input graph.
*
* @param UPR represents the feasible upward planar subgraph after the call. \a UPR has to be initialzed as a
* UpwardPlanRep of the input graph \a G and is modified.
* The subgraph is represented as an upward planar representation.
* @param delEdges is the list of deleted edges which are deleted from the input graph in order to obtain the subgraph.
* The edges are edges of the original graph of UPR.
* \return the status of the result.
*/
ReturnType call(UpwardPlanRep &UPR,
List<edge> &delEdges)
{
return doCall(UPR, delEdges);
}
//! Computes a upward planarized representation of the input graph (shorthand for call)
ReturnType operator()(UpwardPlanRep &UPR,
List<edge> &delEdges)
{
return call(UPR, delEdges);
}
protected:
/**
* \brief Computes a feasible upward planar subgraph of the input graph.
*
* @param UPR represents the feasible upward planar subgraph after the call. \a UPR has to be initialzed as a
* UpwardPlanRep of the input graph \a G and is modified.
* The subgraph is represented as an upward planar representation.
* @param delEdges is the list of deleted edges which are deleted from the input graph in order to obtain the subgraph.
* The edges are edges of the original graph G.
* \return the status of the result.
*/
virtual ReturnType doCall(UpwardPlanRep &UPR,
List<edge> &delEdges) = 0;
OGDF_MALLOC_NEW_DELETE
};
} // end namespace ogdf
#endif
|