summaryrefslogtreecommitdiff
path: root/src/Skeleton_blocker/concept
diff options
context:
space:
mode:
authorsalinasd <salinasd@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2014-12-16 14:18:30 +0000
committersalinasd <salinasd@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2014-12-16 14:18:30 +0000
commit54c6bc50795f53ff1a1227c098f0d4fe84a8d885 (patch)
treec4ef9cd1b9dfdc83e2e54c89be9affae3a4dc940 /src/Skeleton_blocker/concept
parent8c98ccb2c339e6817b8deed732cdffb216ed2cf2 (diff)
doc + problem test
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@356 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Diffstat (limited to 'src/Skeleton_blocker/concept')
-rw-r--r--src/Skeleton_blocker/concept/SkeletonBlockerDS.h8
-rw-r--r--src/Skeleton_blocker/concept/SkeletonBlockerGeometricDS.h15
2 files changed, 15 insertions, 8 deletions
diff --git a/src/Skeleton_blocker/concept/SkeletonBlockerDS.h b/src/Skeleton_blocker/concept/SkeletonBlockerDS.h
index 5cd3a22c..c0386590 100644
--- a/src/Skeleton_blocker/concept/SkeletonBlockerDS.h
+++ b/src/Skeleton_blocker/concept/SkeletonBlockerDS.h
@@ -16,9 +16,11 @@ namespace skbl {
-/** \brief Concept that must be passed to
- * the template class Skeleton_blockers_complex
- *
+/** \brief Concept for the template class passed for Skeleton_blocker_complex.
+ * Most importantly, it contains the nodes for vertices and edges
+ * (Graph_vertex and Graph_edge) that are stored in the simplicial
+ * complex. The user can redefine these classes to attach
+ * additional information to vertices and edges.
*/
struct SkeletonBlockerDS
{
diff --git a/src/Skeleton_blocker/concept/SkeletonBlockerGeometricDS.h b/src/Skeleton_blocker/concept/SkeletonBlockerGeometricDS.h
index 23edaaef..fad680d0 100644
--- a/src/Skeleton_blocker/concept/SkeletonBlockerGeometricDS.h
+++ b/src/Skeleton_blocker/concept/SkeletonBlockerGeometricDS.h
@@ -9,10 +9,15 @@
#ifndef GUDHI_SKELETONBLOCKERGEOMETRICDS_H_
#define GUDHI_SKELETONBLOCKERGEOMETRICDS_H_
-/** \brief Concept that must be passed to
- * the template class Skeleton_blocker_geometric_complex
- *
+/**
+ * \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 the index is just for contraction, to remove
template<typename GeometryTrait>
struct SkeletonBlockerGeometricDS : public SkeletonBlockerDS
{
@@ -35,11 +40,11 @@ struct SkeletonBlockerGeometricDS : public SkeletonBlockerDS
/**
* @brief Access to the point.
*/
- Point& point(){ return point_; }
+ Point& point();
/**
* @brief Access to the point.
*/
- const Point& point() const { return point_; }
+ const Point& point();
};
/**