From 1fc48a45efd4122dbd1587e10e4cb8edd4e0013d Mon Sep 17 00:00:00 2001
From: salinasd <salinasd@636b058d-ea47-450e-bf9e-a15bfbe3eedb>
Date: Wed, 17 Dec 2014 09:22:24 +0000
Subject: doc link

git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@362 636b058d-ea47-450e-bf9e-a15bfbe3eedb

Former-commit-id: fc0af8a276aa2842f08d0451b45a05ed49e1ccb2
---
 src/Contraction/example/Rips_contraction.cpp     | 63 +++++++++++++-----------
 src/Contraction/include/gudhi/Edge_contraction.h | 25 ++++++++--
 2 files changed, 55 insertions(+), 33 deletions(-)

(limited to 'src/Contraction')

diff --git a/src/Contraction/example/Rips_contraction.cpp b/src/Contraction/example/Rips_contraction.cpp
index 869a3682..9d185f81 100644
--- a/src/Contraction/example/Rips_contraction.cpp
+++ b/src/Contraction/example/Rips_contraction.cpp
@@ -1,24 +1,24 @@
- /*    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/>.
-  */
+/*    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/>.
+ */
 #include <boost/timer/timer.hpp>
 #include <iostream>
 #include "gudhi/Edge_contraction.h"
@@ -69,7 +69,6 @@ int main (int argc, char *argv[])
 		return -1;
 	}
 
-	boost::timer::auto_cpu_timer t;
 	Complex complex;
 
 	// load the points
@@ -78,14 +77,15 @@ int main (int argc, char *argv[])
 		std::cerr << "Unable to read file:"<<argv[1]<<std::endl;
 		return EXIT_FAILURE;
 	}
-	std::cout << "build the Rips complex"<<std::endl;
+	std::cout << "Build the Rips complex"<<std::endl;
 
 	build_rips(complex,atof(argv[2]));
 
+	boost::timer::auto_cpu_timer t;
 
 	std::cout << "Initial complex has "<<
-			complex.num_vertices()<<" vertices, and "<<
-			complex.num_edges()<<" edges."<<std::endl;
+			complex.num_vertices()<<" vertices and "<<
+			complex.num_edges()<<" edges"<<std::endl;
 
 	Complex_contractor contractor(complex,
 			new Edge_length_cost<Profile>,
@@ -94,10 +94,17 @@ int main (int argc, char *argv[])
 			contraction::make_remove_popable_blockers_visitor<Profile>());
 	contractor.contract_edges();
 
-	std::cout << "Resulting complex has "<<
+	std::cout << "Counting final number of simplices \n";
+	unsigned num_simplices = std::distance(complex.simplex_range().begin(),complex.simplex_range().end());
+
+	std::cout << "Final complex has "<<
 			complex.num_vertices()<<" vertices, "<<
-			complex.num_edges()<<" edges and "<<
-			complex.num_blockers()<<" blockers"<<std::endl;
+			complex.num_edges()<<" edges, "<<
+			complex.num_blockers()<<" blockers and "<<
+			num_simplices<<" simplices"<<std::endl;
+
+
+	std::cout << "Time to simplify and enumerate simplices:\n";
 
 	return EXIT_SUCCESS;
 }
diff --git a/src/Contraction/include/gudhi/Edge_contraction.h b/src/Contraction/include/gudhi/Edge_contraction.h
index 895044ce..a8a342e6 100644
--- a/src/Contraction/include/gudhi/Edge_contraction.h
+++ b/src/Contraction/include/gudhi/Edge_contraction.h
@@ -33,6 +33,9 @@
 #include "gudhi/Utils.h"
 
 
+namespace Gudhi{
+namespace contraction{
+
 
 /** \defgroup contr Contraction
 
@@ -41,7 +44,7 @@
 \section Introduction
 
 The purpose of this package is to offer a user-friendly interface for edge contraction simplification of huge simplicial complexes.
-It uses the Skeleton-Blocker data-structure whose size remains small  during simplification 
+It uses the \ref skbl data-structure whose size remains small  during simplification 
 of most used geometrical complexes in topological data analysis such as the Rips or the Delaunay complexes (much lower than the total number of simplices in practice).
 
 The edge contraction operation consists in identifying two vertices of a simplicial complex. 
@@ -71,18 +74,29 @@ This class design is policy based and heavily inspired from the similar edge col
 Four policies can be customized in this package.
 
 \li Cost_policy: specify how much cost an edge contraction of a given edge. The edge with lowest cost is iteratively picked and contracted if valid.
-\li Valid_policy: specify if a given edge contraction is valid. For instance, this policy can check the link condition which ensures that the homotopy type is preserved afer the edge contraction.
-\li Placement: every time an edge is contracted, its points are merge to one point specified by this policy. This may be the middle of the edge of some more sofisticated point such as the minimum of a cost as in 
+\li Valid_contraction_policy: specify if a given edge contraction is valid. For instance, this policy can check the link condition which ensures that the homotopy type is preserved afer the edge contraction.
+\li Placement_policy: every time an edge is contracted, its points are merge to one point specified by this policy. This may be the middle of the edge of some more sofisticated point such as the minimum of a cost as in 
 \cite Garland.
 
 
 \subsection Visitor
 
-A visitor which implements the class Contraction_visitor gets called when several 
+A visitor which implements the class Contraction_visitor gets called at several key moments
+during the simplification:
+
+\li when the algorithms starts or ends
+\li when an edge is seen for the first time
+\li when an edge is considered for an edge contraction
+\li before and after an edge is contracted
+
+This allows to implements most of edge contraction based algorithm with this 
+package. 
 
 
+\section Performance 
 
 
+TODO show curve CGAL
 
 \section Example
 
@@ -183,6 +197,7 @@ int main (int argc, char *argv[])
 */
 /** @} */  // end defgroup 
 
-
+}
+}
 
 #endif /* GUDHI_EDGE_CONTRACTION_H_ */
-- 
cgit v1.2.3