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
|
/*
* $Revision: 3504 $
*
* last checkin:
* $Author: beyer $
* $Date: 2013-05-16 14:49:39 +0200 (Thu, 16 May 2013) $
***************************************************************/
/** \file
* \brief Declaration of CrossingMinimization Module, an interface for crossing minimization algorithms
*
* \author Markus Chimani
*
* \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_CROSSING_MINIMIZATION_MODULE_H
#define OGDF_CROSSING_MINIMIZATION_MODULE_H
#include <ogdf/planarity/PlanRep.h>
#include <ogdf/basic/Module.h>
#include <ogdf/basic/Timeouter.h>
namespace ogdf {
//! Base class for crossing minimization algorithms.
class OGDF_EXPORT CrossingMinimizationModule : public Module, public Timeouter
{
public:
//! Initializes a crossing minimization module (default constructor).
CrossingMinimizationModule() { }
//! Initializes an crossing minimization module (copy constructor).
CrossingMinimizationModule(const CrossingMinimizationModule &cmm) : Timeouter(cmm) { }
//! Destructor.
virtual ~CrossingMinimizationModule() { }
//! Returns a new instance of the crossing minimization module with the same option settings.
virtual CrossingMinimizationModule *clone() const = 0;
//! Computes a planarized representation of the input graph.
/**
* @param pr represents the input graph as well as the computed planarized representation
* after the call. \a pr has to be initialzed as a PlanRep of the input graph and
* is modified to obatain the planarized representation (crossings are replaced
* by dummy vertices with degree four).
* @param cc is the index of the connected component in \a pr that is considered.
* @param crossingNumber is assigned the number of crossings.
* @param pCostOrig points to an edge array (of the original graph) that gives the cost of each edge.
* May be a 0-pointer, in which case all edges have cost 1.
* @param pForbiddenOrig points to an edge array (of the original graph) specifying which edges are not
* allowed to be crossed. May be a 0-pointer, in which case no edges are forbidden.
* @param pEdgeSubGraphs points to an edge array (of the original graph) specifying to which subgraph an edge belongs.
* @return the status of the result.
*/
ReturnType call(PlanRep &pr,
int cc,
int& crossingNumber,
const EdgeArray<int> *pCostOrig = 0,
const EdgeArray<bool> *pForbiddenOrig = 0,
const EdgeArray<__uint32> *pEdgeSubGraphs = 0)
{
return doCall(pr, cc, pCostOrig, pForbiddenOrig, pEdgeSubGraphs, crossingNumber);
}
//! Computes a planarized representation of the input graph.
/**
* @param pr represents the input graph as well as the computed planarized representation
* after the call. \a pr has to be initialzed as a PlanRep of the input graph and
* is modified to obatain the planarized representation (crossings are replaced
* by dummy vertices with degree four).
* @param cc is the index of the connected component in \a pr that is considered.
* @param crossingNumber is assigned the number of crossings.
* @param pCostOrig points to an edge array (of the original graph) that gives the cost of each edge.
* May be a 0-pointer, in which case all edges have cost 1.
* @param pForbiddenOrig points to an edge array (of the original graph) specifying which edges are not
* allowed to be crossed. May be a 0-pointer, in which case no edges are forbidden.
* @param pEdgeSubGraphs points to an edge array (of the original graph) specifying to which subgraph an edge belongs.
* @return the status of the result.
*/
ReturnType operator()(PlanRep &pr,
int cc,
int & crossingNumber,
const EdgeArray<int> *pCostOrig = 0,
const EdgeArray<bool> *pForbiddenOrig = 0,
const EdgeArray<__uint32> *pEdgeSubGraphs = 0)
{
return call(pr, cc, crossingNumber, pCostOrig, pForbiddenOrig, pEdgeSubGraphs);
}
protected:
//! Actual algorithm call that needs to be implemented by derived classes.
/**
* @param pr represents the input graph as well as the computed planarized representation
* after the call. \a pr has to be initialzed as a PlanRep of the input graph and
* is modified to obatain the planarized representation (crossings are replaced
* by dummy vertices with degree four).
* @param cc is the index of the connected component in \a pr that is considered.
* @param crossingNumber is assigned the number of crossings.
* @param pCostOrig points to an edge array (of the original graph) that gives the cost of each edge.
* May be a 0-pointer, in which case all edges have cost 1.
* @param pForbiddenOrig points to an edge array (of the original graph) specifying which edges are not
* allowed to be crossed. May be a 0-pointer, in which case no edges are forbidden.
* @param pEdgeSubGraphs points to an edge array (of the original graph) specifying to which subgraph an edge belongs.
* @return the status of the result.
*/
virtual ReturnType doCall(PlanRep &pr,
int cc,
const EdgeArray<int> *pCostOrig,
const EdgeArray<bool> *pForbiddenOrig,
const EdgeArray<__uint32> *pEdgeSubGraphs,
int &crossingNumber) = 0;
OGDF_MALLOC_NEW_DELETE
};
} // end namespace ogdf
#endif
|
