File: CrossingMinimizationModule.h

package info (click to toggle)
tulip 4.6.0dfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 139,284 kB
  • ctags: 35,942
  • sloc: cpp: 289,758; ansic: 27,264; python: 1,256; sh: 923; yacc: 522; xml: 337; makefile: 258; php: 66; lex: 55
file content (163 lines) | stat: -rw-r--r-- 5,521 bytes parent folder | download
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
/*
 * $Revision: 2599 $
 *
 * last checkin:
 *   $Author: chimani $
 *   $Date: 2012-07-15 22:39:24 +0200 (So, 15. Jul 2012) $
 ***************************************************************/

/** \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/extended_graph_alg.h>
#include <ogdf/basic/Module.h>
#include <ogdf/basic/Logger.h>
#include <ogdf/basic/Timeouter.h>


namespace ogdf {

/**
 * \brief Interface for crossing minimization algorithms.
 *
 */
class OGDF_EXPORT CrossingMinimizationModule : public Module, public Timeouter
{
public:
	//! Initializes a crossing minimization module.
	CrossingMinimizationModule() { }

	// destruction
	virtual ~CrossingMinimizationModule() { }

	/**
	 * \brief Computes a planarized representation of the input graph.
	 *
	 * @param PG represents the input graph as well as the computed planarized
	 *        representation after the call. \a PG 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 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.
	 * @param cost points to an edge array that gives the cost of each edge. If cost
	 *        = 0, all edges have cost 1.
	 * @param subgraphs
	 * \return the status of the result.
	 */
	ReturnType call(PlanRep &PG,
			int cc,
			int&  crossingNumber,
			const EdgeArray<int>  * cost = 0,
			const EdgeArray<bool> * forbid = 0,
			const EdgeArray<unsigned int> * subgraphs = 0)
	{
		m_useCost = (cost != 0);
		m_useForbid = (forbid != 0);
		m_useSubgraphs = (subgraphs != 0);

		if(!useCost())      cost      = OGDF_NEW EdgeArray<int> (PG.original(), 1);
		if(!useForbid())    forbid    = OGDF_NEW EdgeArray<bool> (PG.original(), 0);
		if(!useSubgraphs()) subgraphs = OGDF_NEW EdgeArray<unsigned int> (PG.original(), 1);

		ReturnType R = doCall(PG, cc, *cost, *forbid, *subgraphs, crossingNumber);

		if(!useCost())      delete cost;
		if(!useForbid())    delete forbid;
		if(!useSubgraphs()) delete subgraphs;
		return R;
	};

	//! Computes a planarized representation of the input graph (shorthand for call)
	ReturnType operator()(PlanRep &PG,
			int cc,
			int&  crossingNumber,
			const EdgeArray<int>  * cost = 0,
			const EdgeArray<bool> * forbid = 0,
			const EdgeArray<unsigned int> * const subgraphs = 0) {
		return call(PG, cc, crossingNumber, cost, forbid, subgraphs);
	};

	//! Returns true iff edge costs are given.
	bool useCost() const { return m_useCost; }

	//! Returns true iff forbidden edges are given.
	bool useForbid() const { return m_useForbid; }

	bool useSubgraphs() const { return m_useSubgraphs; }

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
	 *        representation after the call. \a PG is initialzed as a
	 *        PlanRep of the input graph and has to be modified so that it represents
	 *        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 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.
	 * @param cost points to an edge array that gives the cost of each edge.
	 * @param subgraphs
	 * \return the status of the result.
	 */
	virtual ReturnType doCall(PlanRep &PG,
		int cc,
		const EdgeArray<int>  &cost,
		const EdgeArray<bool> &forbid,
		const EdgeArray<unsigned int> &subgraphs,
		int& crossingNumber) = 0;

	OGDF_MALLOC_NEW_DELETE

private:
	bool m_useCost; //!< True iff edge costs are given.
	bool m_useForbid; //!< True iff forbidden edges are given.
	bool m_useSubgraphs;
};

} // end namespace ogdf

#endif