summaryrefslogtreecommitdiff
path: root/src/Contraction/include/gudhi/Skeleton_blocker_contractor.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/Contraction/include/gudhi/Skeleton_blocker_contractor.h')
-rw-r--r--src/Contraction/include/gudhi/Skeleton_blocker_contractor.h33
1 files changed, 24 insertions, 9 deletions
diff --git a/src/Contraction/include/gudhi/Skeleton_blocker_contractor.h b/src/Contraction/include/gudhi/Skeleton_blocker_contractor.h
index 4dc7952c..56f4891f 100644
--- a/src/Contraction/include/gudhi/Skeleton_blocker_contractor.h
+++ b/src/Contraction/include/gudhi/Skeleton_blocker_contractor.h
@@ -1,8 +1,23 @@
-/*
- * Skeleton_blocker_contractor.h
+/* This file is part of the Gudhi Library. The Gudhi library
+ * (Geometric Understanding in Higher Dimensions) is a generic C++
+ * library for computational topology.
*
- * Created on: Feb 11, 2014
- * Author: dsalinas
+ * 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_SKELETON_BLOCKER_CONTRACTOR_H_
@@ -13,7 +28,6 @@
// todo remove the queue to be independent from cgald
#include "gudhi/Contraction/CGAL_queue/Modifiable_priority_queue.h"
-//#include <CGAL/Modifiable_priority_queue.h>
#include <list>
@@ -53,7 +67,9 @@ Valid_contraction_policy<Profile>* make_link_valid_contraction(){
}
-// visitor that remove popable blockers after an edge contraction
+/**
+*@brief Visitor to remove popable blockers after an edge contraction.
+*/
template <class Profile>
class Contraction_visitor_remove_popable : public Contraction_visitor<Profile>{
public:
@@ -101,9 +117,9 @@ Contraction_visitor<Profile>* make_remove_popable_blockers_visitor(){
*@class Skeleton_blocker_contractor
*@brief Class that allows to contract iteratively edges of a simplicial complex.
*
- * @details Basically, the simplification algorithm consists in iteratively picking the
+ * @details The simplification algorithm consists in iteratively picking the
* edge with lowest cost and performing an edge contraction if the contraction is valid.
- * This class is policy based (and much inspired from the edge collapse package of CGAL).
+ * This class is policy based (and much inspired from the edge collapse package of CGAL http://doc.cgal.org/latest/Surface_mesh_simplification/index.html).
*
* Policies that can be changed are :
* - the cost policy : how much cost an edge contraction
@@ -111,7 +127,6 @@ Contraction_visitor<Profile>* make_remove_popable_blockers_visitor(){
* - the valid contraction policy : is the contraction valid. For instance, it can be
* a topological condition (link condition) or a geometrical condition (normals messed up).
*
- * TODO expliquer la pile
*/
template<
class GeometricSimplifiableComplex,