summaryrefslogtreecommitdiff
path: root/include/gudhi/Contraction/policies/Cost_policy.h
blob: f4d343ec34c87cb35c8c94e9572a22d921f9e55f (plain)
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
/*    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 CONTRACTION_POLICIES_COST_POLICY_H_
#define CONTRACTION_POLICIES_COST_POLICY_H_

#include <boost/optional.hpp>

namespace Gudhi {

namespace contraction {

/**
 *@brief Policy to specify the cost of contracting an edge.
 *@ingroup contr
 */
template< typename EdgeProfile>
class Cost_policy {
 public:
  typedef typename EdgeProfile::Point Point;
  typedef typename EdgeProfile::Graph_vertex Graph_vertex;

  typedef boost::optional<double> Cost_type;

  virtual Cost_type operator()(const EdgeProfile& profile, const boost::optional<Point>& placement) const = 0;

  virtual ~Cost_policy() { }
};

}  // namespace contraction

}  // namespace Gudhi

#endif  // CONTRACTION_POLICIES_COST_POLICY_H_