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
|
/*
* $Revision: 2523 $
*
* last checkin:
* $Author: gutwenger $
* $Date: 2012-07-02 20:59:27 +0200 (Mon, 02 Jul 2012) $
***************************************************************/
/** \file
* \brief Declares the base class ShellingOrderModule for modules
* that compute a shelling order of a graph.
*
* \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
***************************************************************/
#ifdef _MSC_VER
#pragma once
#endif
#ifndef OGDF_SHELLING_ORDER_MODULE_H
#define OGDF_SHELLING_ORDER_MODULE_H
#include <ogdf/planarlayout/ShellingOrder.h>
namespace ogdf {
/**
* \brief Base class for modules that compute a shelling order of a graph.
*
*/
class OGDF_EXPORT ShellingOrderModule
{
public:
//! Computes a shelling order of an embedded graph G such that \a adj lies on the external face.
/**
* @param G is the input graph; \a G must represent a combinatorial embedding.
* @param order is assigned the shelling order.
* @param adj is an adjacency entry on the external face; if \a adj is 0, a suitable
* external face is chosen.
*/
void call(const Graph &G, ShellingOrder &order, adjEntry adj = 0);
//! Computes a lefmost shelling order of an embedded graph G such that \a adj lies on the external face.
/**
* @param G is the input graph; \a G must represent a combinatorial embedding.
* @param order is assigned the shelling order.
* @param adj is an adjacency entry on the external face; if \a adj is 0, a suitable
* external face is chosen.
*/
void callLeftmost(const Graph &G, ShellingOrder &order, adjEntry adj = 0);
//! Sets the option <i>base ratio</i> to \a x.
void baseRatio(double x) {m_baseRatio = x;}
//! Returns the current setting of the option <b>base ratio</b>.
double baseRatio() const {return m_baseRatio;}
virtual ~ShellingOrderModule() { }
protected:
//! This pure virtual function does the actual computation.
/**
* A derived class must implement this method. It is called with the embedded graph
* and an adjacency entry describing the external face, and must return the
* computed order in \a partition.
* @param G is the embedded input graph.
* @param adj is an adjacency entry on the external face.
* @param partition returns the coputed shelling order.
*/
virtual void doCall(const Graph &G,
adjEntry adj,
List<ShellingOrderSet> &partition) = 0;
double m_baseRatio; //! The option <i>base ratio</i>.
};
} // end namespace ogdf
#endif
|
