module toplex_map added

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

Former-commit-id: 61f8f8a2d3920dbc30b86dd808a0e316383af137

2 files changed, 57 insertions, 0 deletions

diff --git a/src/Toplex_map/doc/Intro_Toplex_map.h b/src/Toplex_map/doc/Intro_Toplex_map.h
new file mode 100644
index 00000000..da9562ec
--- /dev/null
+++ b/src/Toplex_map/doc/Intro_Toplex_map.h
@@ -0,0 +1,57 @@
+/*    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:       François Godi
+ *
+ *    Copyright (C) 2017  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 DOC_TOPLEX_MAP_H_
+#define DOC_TOPLEX_MAP_H_
+
+// needs namespace for Doxygen to link on classes
+namespace Gudhi {
+
+/**  \defgroup toplex_map Toplex Map
+ * 
+ * \author    Fran&ccedil;ois Godi
+ * @{
+ * 
+ * \section toplexmapdefinition Definition
+ * 
+ * Let's consider a simplicial complex, denote by $d$ its dimension
+ * and by $k$ its number of maximal simplices.
+ * Furthermore, denote by $\gamma_0$ the maximal number of toplices, i.e. maximal simplices,
+ * that contain a same vertex.
+ *
+ * The goal of the Toplex Map is both to represent the complex in optimal
+ * O(kd) space and to provide fast standard operations such as : insertion, removal
+ * and membership of a simplex, contraction of an edge, collapses. The time needed
+ * for these operation is linear or quadratic in $\gamma_0$ and $d$.
+ *
+ * Toplex map is composed firstly of a raw storage of toplices and secondly of a
+ * map which associate any vertex to a set of pointers toward all toplices
+ * containing this vertex.
+ *
+ * \image html map.png
+ *
+ */
+/** @} */  // end defgroup toplex_map
+
+}  // namespace Gudhi
+
+#endif  // DOC_TOPLEX_MAP_H_
diff --git a/src/Toplex_map/doc/map.png b/src/Toplex_map/doc/map.png
new file mode 100644
index 00000000..d1987043
--- /dev/null
+++ b/src/Toplex_map/doc/map.png