summaryrefslogtreecommitdiff
path: root/src/cython/doc/index.rst
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-08-12 15:29:48 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-08-12 15:29:48 +0000
commit5b6bebd9a8072d8998b0c741e5b40de0cfe5dc8e (patch)
tree995194307af2d09f44dcdd9fd1494f3ada6e966a /src/cython/doc/index.rst
parent46566db4452be7dee8398e1ed5a25add7f80ac39 (diff)
Move cython/src/* in cython/
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/ST_cythonize@1436 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 8f971ef16ef6df597d5d3667db0eecbca94233b2
Diffstat (limited to 'src/cython/doc/index.rst')
-rw-r--r--src/cython/doc/index.rst63
1 files changed, 63 insertions, 0 deletions
diff --git a/src/cython/doc/index.rst b/src/cython/doc/index.rst
new file mode 100644
index 00000000..5245d69d
--- /dev/null
+++ b/src/cython/doc/index.rst
@@ -0,0 +1,63 @@
+.. GUDHI documentation master file, created by
+ sphinx-quickstart on Thu Jun 30 09:55:51 2016.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+GUDHI's documentation
+#####################
+
+.. image:: img/Gudhi_banner.png
+ :align: center
+
+Introduction
+************
+
+The Gudhi library (Geometry Understanding in Higher Dimensions) is a generic
+open source C++ library for Computational Topology and Topological Data
+Analysis (`TDA <https://en.wikipedia.org/wiki/Topological_data_analysis>`_).
+The GUDHI library intends to help the development of new algorithmic solutions
+in TDA and their transfer to applications. It provides robust, efficient,
+flexible and easy to use implementations of state-of-the-art algorithms and
+data structures.
+
+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.
+* Simplication of simplicial complexes by edge contraction.
+
+All data-structures are generic and several of their aspects can be
+parameterized via template classes. We refer to :cite:`gudhilibrary_ICMS14`
+for a detailed description of the design of the library.
+
+Data structures
+***************
+
+Alpha complex
+=============
+
+.. include:: alpha_complex_sum.rst
+
+Cubical complex
+===============
+
+.. include:: cubical_complex_sum.rst
+
+Simplex tree
+============
+
+.. include:: simplex_tree_sum.rst
+
+Witness complex
+===============
+
+.. include:: witness_complex_sum.rst
+
+
+Toolbox
+*******
+
+Persistence cohomology
+======================
+
+.. include:: persistent_cohomology_sum.rst