summaryrefslogtreecommitdiff
path: root/concept/Skeleton_blocker/SkeletonBlockerGeometricDS.h
blob: 477464c45fa940e77d18bfb23c4b4af1fe37d0ac (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
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
/*    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
 *
 *    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 CONCEPT_SKELETON_BLOCKER_SKELETONBLOCKERGEOMETRICDS_H_
#define CONCEPT_SKELETON_BLOCKER_SKELETONBLOCKERGEOMETRICDS_H_

namespace Gudhi {
namespace skeleton_blocker {

/** 
 * \brief Concept for template class of  Skeleton_blocker_geometric_complex .
 * It must specify a GeometryTrait which contains a Point definition.
 * 
 * Graph_vertex must specify how to access to a point.
 * Graph_edge must specify how to access to an index.
 * 
 */
// TODO(DS): the index is just for contraction, to remove

template<typename GeometryTrait>
struct SkeletonBlockerGeometricDS : public SkeletonBlockerDS {
  /**
   * Geometry information.
   */
  typedef GeometryTrait GT;

  /**
   * Type of point (should be the same as GT::Point).
   */
  typedef typename GeometryTrait::Point Point;

  /**
   * @brief Vertex that stores a point.
   */
  class Graph_vertex : public SkeletonBlockerDS::Graph_vertex {
   public:
    /**
     * @brief Access to the point.
     */
    Point& point();
    /**
     * @brief Access to the point.
     */
    const Point& point();
  };

  /**
   * @brief Edge that allows to access to an index.
   * The indices of the edges are used to store heap information
   * in the edge contraction algorithm.
   */
  class Graph_Edge : public SkeletonBlockerDS::Graph_edge {
   public:
    /**
     * @brief Access to the index.
     */
    int& index();
    /**
     * @brief Access to the index.
     */
    int index();
  };
};

}  // namespace skeleton_blocker

namespace skbl = skeleton_blocker;

}  // namespace Gudhi

#endif  // CONCEPT_SKELETON_BLOCKER_SKELETONBLOCKERGEOMETRICDS_H_