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
|
/* This file is part of the Gudhi Library. The Gudhi library
* (Geometric Understanding in Higher Dimensions) is a generic C++
* library for computational topology.
*
* Author(s): David Salinas
*
* Copyright (C) 2014 INRIA Sophia Antipolis-Mediterranee (France)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* 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.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef GUDHI_CONTRACTION_VISITOR_H_
#define GUDHI_CONTRACTION_VISITOR_H_
#include "gudhi/Contraction/Edge_profile.h"
#include "boost/optional.hpp"
namespace Gudhi{
namespace contraction {
/**
*@class Contraction_visitor
*@brief Interface for a visitor of the edge contraction process.
*@ingroup contr
*/
template <typename EdgeProfile>
class Contraction_visitor {//: public Dummy_complex_visitor<typename EdgeProfile::Vertex_handle> {
public:
//typedef typename ComplexType::GeometryTrait GT;
typedef EdgeProfile Profile;
typedef double FT;
typedef typename Profile::Complex Complex;
typedef Complex ComplexType;
typedef typename ComplexType::Point Point;
virtual ~Contraction_visitor(){};
/**
* @brief Called before the edge contraction process starts.
*/
virtual void on_started (ComplexType & complex){}
/**
* @brief Called when the algorithm stops.
*/
virtual void on_stop_condition_reached (){}
/**
* @brief Called during the collecting phase (when a cost is assigned to the edges), for each edge collected.
*/
virtual void on_collected (const Profile &profile, boost::optional< FT > cost){}
/**
* @brief Called during the processing phase (when edges are contracted), for each edge that is selected.
*/
virtual void on_selected (const Profile &profile, boost::optional< FT > cost, int initial_count, int current_count){}
/**
* @brief Called when an edge is about to be contracted and replaced by a vertex whose position is *placement.
*/
virtual void on_contracting(const Profile &profile, boost::optional< Point > placement){
}
/**
* @brief Called when after an edge has been contracted onto a new point placement.
* A possibility would to remove popable blockers at this point for instance.
*/
virtual void on_contracted(const Profile &profile, boost::optional< Point > placement){
}
/**
* @brief Called for each selected edge which cannot be contracted because the ValidContractionPredicate is false
*/
virtual void on_non_valid(const Profile &profile){}
};
} // namespace contraction
} // namespace GUDHI
#endif /* GUDHI_CONTRACTION_VISITOR_H_ */
|