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
160
161
162
163
164
165
|
/*
* $Revision: 2583 $
*
* last checkin:
* $Author: gutwenger $
* $Date: 2012-07-12 01:02:21 +0200 (Thu, 12 Jul 2012) $
***************************************************************/
/** \file
* \brief Declaration of interface for edge insertion algorithms
*
* \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
***************************************************************/
#ifdef _MSC_VER
#pragma once
#endif
#ifndef OGDF_UPWARD_EDGE_INSERTER_MODULE_H
#define OGDF_UPWARD_EDGE_INSERTER_MODULE_H
#include <ogdf/upward/UpwardPlanRep.h>
#include <ogdf/basic/Module.h>
namespace ogdf {
class OGDF_EXPORT UpwardEdgeInserterModule : public Module{
public:
//! Initializes an edge insertion module.
UpwardEdgeInserterModule() { }
// destruction
virtual ~UpwardEdgeInserterModule() { }
/**
* \brief Inserts all edges in \a origEdges into \a UPR.
*
* @param UPR is the input upward planarized representation of a FUPS and will also receive the result.
* @param origEdges is the list of original edges (edges in the original graph
* of \a UPR) that have to be inserted.
* \return the status of the result.
*/
ReturnType call(UpwardPlanRep &UPR, const List<edge> &origEdges) {
return doCall(UPR, origEdges, 0, 0);
}
/**
* \brief Inserts all edges in \a origEdges with given costs into \a UPR.
*
* @param UPR is the input upward planarized representation of a FUPS and will also receive the result.
* @param costOrig points to an edge array containing the costs of original edges; edges in
* \a UPR without an original edge have zero costs.
* @param origEdges is the list of original edges (edges in the original graph
* of \a UPR) that have to be inserted.
* \return the status of the result.
*/
ReturnType call(UpwardPlanRep &UPR,
const EdgeArray<int> &costOrig,
const List<edge> &origEdges)
{
return doCall(UPR, origEdges, &costOrig, 0);
}
/**
* \brief Inserts all edges in \a origEdges with given forbidden edges into \a UPR.
*
* @param UPR is the input upward planarized representation of a FUPS and will also receive the result.
* @param costOrig points to an edge array containing the costs of original edges; edges in
* \a UPR without an original edge have zero costs.
* @param forbidOriginal points to an edge array indicating if an original edge is
* forbidden to be crossed.
* @param origEdges is the list of original edges (edges in the original graph
* of \a UPR) that have to be inserted.
*/
ReturnType call(UpwardPlanRep &UPR,
const EdgeArray<int> &costOrig,
const EdgeArray<bool> &forbidOriginal,
const List<edge> &origEdges)
{
return doCall(UPR, origEdges, &costOrig, &forbidOriginal);
}
/**
* \brief Inserts all edges in \a origEdges with given forbidden edges into \a UPR.
*
* \pre No forbidden edge may be in \a origEdges.
*
* @param UPR is the input upward planarized representation of a FUPS and will also receive the result.
* @param forbidOriginal points to an edge array indicating if an original edge is
* forbidden to be crossed.
* @param origEdges is the list of original edges (edges in the original graph
* of \a UPR) that have to be inserted.
* \return the status of the result.
*/
ReturnType call(UpwardPlanRep &UPR,
const EdgeArray<bool> &forbidOriginal,
const List<edge> &origEdges)
{
return doCall(UPR, origEdges, 0, &forbidOriginal);
}
protected:
/**
* \brief Actual algorithm call that has to be implemented by derived classes.
*
* @param UPR is the input upward planarized representation of a FUPS and will also receive the result.
* @param origEdges is the list of original edges (edges in the original graph
* of \a UPR) that have to be inserted.
* @param costOrig points to an edge array containing the costs of original edges; edges in
* \a UPR without an original edge have zero costs.
* @param forbiddenEdgeOrig points to an edge array indicating if an original edge is
* forbidden to be crossed.
*/
virtual ReturnType doCall(UpwardPlanRep &UPR,
const List<edge> &origEdges,
const EdgeArray<int> *costOrig,
const EdgeArray<bool> *forbiddenEdgeOrig
) = 0;
OGDF_MALLOC_NEW_DELETE
};
} // end namespace ogdf
#endif
|
