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
|
/*
* $Revision: 2523 $
*
* last checkin:
* $Author: gutwenger $
* $Date: 2012-07-02 20:59:27 +0200 (Mon, 02 Jul 2012) $
***************************************************************/
/** \file
* \brief Declaration of interface for graph augmentation 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
***************************************************************/
#ifdef _MSC_VER
#pragma once
#endif
#ifndef OGDF_AUGMENTATION_MODULE_H
#define OGDF_AUGMENTATION_MODULE_H
#include <ogdf/basic/Graph.h>
namespace ogdf {
/**
* \brief The base class for graph augmentation algorithms.
*
* The class \a AugmentationModule is the base class for augmentation modules.
* An augmentation module transforms an input graph \a G into an output
* graph \a G' by adding edges, such that \a G' has a certain
* property, e.g., biconnected.
*
* <H3>Implementation of Augmentation Algorithms</H3>
* An implementation of an augmentation module must override
* the protected method doCall(G,L), which gets as
* input a graph reference \a G. It then adds the augmented edges
* to \a G and returns the list of added edges in \a L.
*/
class OGDF_EXPORT AugmentationModule {
public:
//! Initializes an augmentation module.
AugmentationModule() { }
// destruction
virtual ~AugmentationModule() { }
//! Calls the augmentation module for graph \a G.
void call(Graph& G) {
List<edge> L;
call(G,L);
}
//! Calls the augmentation module for graph \a G.
void operator()(Graph& G) { call(G); }
/**
* \brief Calls the augmentation module for graph \a G.
*
* Returns the list of added edges in \a L.
*/
void call(Graph& G, List<edge> &L) {
doCall(G,L);
m_nAddedEdges = L.size();
}
/**
* \brief Calls the augmentation module for graph \a G.
*
* Returns the list of added edges in \a L.
*/
void operator()(Graph& G, List<edge> &L) { call(G,L); }
//! Returns the number of added edges.
int numberOfAddedEdges() const {
return m_nAddedEdges;
}
protected:
/**
* \brief Implements the augmentation algorithm for graph \a G.
*
* Returns the list of added edges in \a L.
*/
virtual void doCall(Graph& G, List<edge> &L) = 0;
private:
int m_nAddedEdges;
OGDF_MALLOC_NEW_DELETE
};
} // end namespace ogdf
#endif
|
