diff options
author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-03-23 09:16:03 +0000 |
---|---|---|
committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-03-23 09:16:03 +0000 |
commit | 8a0a20484e968b872b911ca964b079442c6c1fe7 (patch) | |
tree | d453db6d031e782e03cbb48a37c16388ecc1cd2d /src/cython/doc/index.rst | |
parent | ccffd3d0e3d27255533b8bd6d51aa5b4210feb90 (diff) | |
parent | f0e209149a6bf1d3b13572f3704986a429130a48 (diff) |
Merge ST_cythonize branch into the trunk
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@2225 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 013d700aaa4b255cc91ff79020b40b7e6c4e7d05
Diffstat (limited to 'src/cython/doc/index.rst')
-rw-r--r-- | src/cython/doc/index.rst | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/src/cython/doc/index.rst b/src/cython/doc/index.rst new file mode 100644 index 00000000..fca63d65 --- /dev/null +++ b/src/cython/doc/index.rst @@ -0,0 +1,87 @@ +GUDHI documentation +################### + +.. image:: img/Gudhi_banner.png + :align: center + +Introduction +************ + +The Gudhi library (Geometry Understanding in Higher Dimensions) is a generic +open source `C++ library <http://gudhi.gforge.inria.fr/doc/latest/>`_, with a +`Cython interface <http://gudhi.gforge.inria.fr/cython/latest/>`_, 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 + +Rips complex +============ + +.. include:: rips_complex_sum.rst + +Simplex tree +============ + +.. include:: simplex_tree_sum.rst + +Tangential complex +================== + +.. include:: tangential_complex_sum.rst + +Witness complex +=============== + +.. include:: witness_complex_sum.rst + + +Toolbox +******* + +Bottleneck distance +=================== + +.. include:: bottleneck_distance_sum.rst + +Persistence cohomology +====================== + +.. include:: persistent_cohomology_sum.rst + +Persistence graphical tools +=========================== + +.. include:: persistence_graphical_tools_sum.rst + +Bibliography +************ + +.. bibliography:: bibliography.bib + :filter: docnames + :style: unsrt |