summaryrefslogtreecommitdiff
path: root/src/common/doc/main_page.h
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2015-10-23 09:40:36 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2015-10-23 09:40:36 +0000
commit3b22ae31478387efd64ae5f185128857f17ca9ee (patch)
tree481cf0a597b8c4f8471e03218f9e46544111b558 /src/common/doc/main_page.h
parentf0b88dfb3523ad6e39b60c6cc56b18ec1fa3cd9f (diff)
generate_version excludes bottleneck for version 1.2.0 - to be removed for 1.3.0
generate_version copies concept for doxygen purpose Contact gudhi-users on skbl and contraction page Doxygen warning fixes Doxygen Software section git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@871 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: bd7e252c2d0528f4bbc40c33a9221e1d6b386510
Diffstat (limited to 'src/common/doc/main_page.h')
-rw-r--r--src/common/doc/main_page.h51
1 files changed, 50 insertions, 1 deletions
diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h
index 315aa0ac..d1060740 100644
--- a/src/common/doc/main_page.h
+++ b/src/common/doc/main_page.h
@@ -7,7 +7,7 @@ The Gudhi library (Geometric Understanding in Higher Dimensions) is a generic C+
topological analysis of high-dimensional data whose goal is to provide robust, efficient, flexible and easy to use
implementations of
state-of-the-art algorithms and data structures for computational topology.
-This library is part of the <a href="https://project.inria.fr/gudhi/">Gudhi project</a>.
+This library is part of the <a class="el" href="https://project.inria.fr/gudhi/">Gudhi project</a>.
The current release of the library allows to use several data-structures for simplicial complexes :
simplex tree, Hasse diagram or skeleton-blocker. Several operations can then be done on top of these
@@ -70,3 +70,52 @@ make
\verbatim Contact: gudhi-users@lists.gforge.inria.fr \endverbatim
*/
+
+/*! \page Software Software
+ * \tableofcontents
+ * \section SoftwareIntroduction Introduction
+ * The GUDHI open source library will provide the central data structures and algorithms that underly applications in geometry understanding in higher dimensions. It is intended to both help the development of new algorithmic solutions inside and outside the project, and to facilitate the transfer of results in applied fields.
+ *
+ * The current release of the GUDHI library includes:
+ *
+ * – Data structures to represent, construct and manipulate simplicial complexes.
+ *
+ * – Algorithms to compute persistent homology and multi-field persistent homology.
+ *
+ * – Simplification methods via implicit representations.
+ *
+ *
+ * The library is available <a class="el" href="https://gforge.inria.fr/frs/?group_id=3865">here</a> and the documentation is
+ * available at this <a class="el" href="http://gudhi.gforge.inria.fr/doc/1.1.0/">webpage</a>.
+ *
+ * \section ReleaseHistory Release history
+ *
+ * – ??-??-2015; release v.1.2.0, Skeleton-Blocker simplex insertion, GudhUI (Gudhi Qt demo), Simplex tree coface function, Clang build issue fix.
+ *
+ * – 12-18-2014; release v.1.1, Skeleton-Blocker data-structure, simplification package, additional examples for topological persistence.
+ *
+ * – 08-12-2014; release v. 1.0.2, initialize simplex keys in initialize_filtration in Simplex_tree
+ *
+ * – 07-11-2014: release v. 1.0.1, bug fix in summing columns in Persistent_cohomology
+ *
+ * – 06-23-2014: release v. 1.0
+ *
+ * \section Citation How to cite Gudhi
+ * Each Gudhi <a class="el" href="modules.html">module</a> (either data structures or algorithms) has an author section.
+ *
+ * Thank you to refer to this section, and to cite the author(s) of all the module you are using.
+ *
+ * \section Soon Coming soon
+ *
+ * – Alpha complex.
+ *
+ * – Bottleneck distance.
+ *
+ * – Zig zag persistence.
+ *
+ * – Witness complex.
+ *
+ * – Tangential complex.
+ *
+ * – Hard clustering.
+*/