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 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
|
/*
* $Revision: 2523 $
*
* last checkin:
* $Author: gutwenger $
* $Date: 2012-07-02 20:59:27 +0200 (Mon, 02 Jul 2012) $
***************************************************************/
/** \file
* \brief Declaration of MMCrossingMinimization Module, an interface
* for minor-monotone crossing minimization algorithms.
*
* \author Carsten Gutwenger
*
* \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_MM_CROSSING_MINIMIZATION_MODULE_H
#define OGDF_MM_CROSSING_MINIMIZATION_MODULE_H
#include <ogdf/planarity/PlanRepExpansion.h>
#include <ogdf/basic/Module.h>
#include <ogdf/basic/Logger.h>
namespace ogdf {
/**
* \brief Interface for minor-monotone crossing minimization algorithms.
*
*/
class OGDF_EXPORT MMCrossingMinimizationModule : public Module
{
public:
//! Initializes a minor-monotone crossing minimization module.
MMCrossingMinimizationModule() { m_nodeSplits = 0; }
// destruction
virtual ~MMCrossingMinimizationModule() { }
/**
* \brief Computes a planarized representation of an expansion of the input graph.
*
* @param PG represents the input graph as well as the computed planarized
* expansion after the call. \a PG has to be initialzed as a
* PlanRepExpansion of the input graph and is modified to obatain the planarized
* representation (nodes are eventually expanded by splitting the node and
* crossings are replaced by dummy vertices with degree four).
* @param cc is the number of the connected component in \a PG that is considered.
* @param crossingNumber is assigned the number of crossings.
* @param forbid points to an edge array indicating which edges are not allowed
* to be crossed, i.e., (*forbid)[e] = true. If forbid = 0, no edges are
* forbidden.
* \return the status of the result.
*/
ReturnType call(PlanRepExpansion &PG,
int cc,
int& crossingNumber,
const EdgeArray<bool> *forbid = 0)
{
return doCall(PG, cc, forbid, crossingNumber, m_nodeSplits, m_splittedNodes);
};
/**
* \brief Performs minor-monotone crossing minimization on \a G.
*
* @param G is the input graph.
* @param cr is assigned the number of crossings.
* @param forbid points to an edge array indicating which edges are not allowed
* to be crossed, i.e., (*forbid)[e] = true. If forbid = 0, no edges are
* forbidden.
* \return the status of the result.
*/
ReturnType call(const Graph &G, int &cr, const EdgeArray<bool> *forbid = 0);
/**
* \brief Performs minor-monotone crossing minimization on \a G for given splittable nodes.
*
* @param G is the input graph.
* @param splittableNodes is the list of nodes that are allowed to be split.
* @param cr is assigned the number of crossings.
* @param forbid points to an edge array indicating which edges are not allowed
* to be crossed, i.e., (*forbid)[e] = true. If forbid = 0, no edges are
* forbidden.
* \return the status of the result.
*/
ReturnType call(const Graph &G,
const List<node> &splittableNodes,
int &cr,
const EdgeArray<bool> *forbid = 0);
/**
* \brief Returns the number of required node splits after the call.
*/
int numberOfNodeSplits() const { return m_nodeSplits; }
int numberOfSplittedNodes() const { return m_splittedNodes; }
protected:
/**
* \brief Actual algorithm call that needs to be implemented by derived classed.
*
* @param PG represents the input graph as well as the computed planarized expansion
* after the call. \a PG is initialized as a PlanRepExpansion of the input
* graph and needs to be modified to obatain the planarized representation
* (crossings are replaced by dummy vertices with degree four).
* @param cc is the number of the connected component in \a PG that is considered.
* @param forbid points to an edge array indicating which edges are not allowed
* to be crossed, i.e., (*forbid)[e] = true.
* @param crossingNumber needs to be assigned the number of crossings.
* @param numNS needs to be assigned the required number of node splits.
* @param numSN needs to be assigned the number of splitted nodes.
* \return the status of the result.
*/
virtual ReturnType doCall(PlanRepExpansion &PG,
int cc,
const EdgeArray<bool> *forbid,
int& crossingNumber,
int& numNS,
int& numSN) = 0;
private:
int m_nodeSplits; //!< The number of required node splits.
int m_splittedNodes; //!< The number of nodes that are split.
OGDF_MALLOC_NEW_DELETE
};
} // end namespace ogdf
#endif
|