summaryrefslogtreecommitdiff
path: root/cython/doc/index.rst
blob: 4e444fb01bd19d7d25eba505ce4c070d3a864841 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
GUDHI Python module documentation
#################################

.. figure::
     ../../doc/common/Gudhi_banner.png
     :alt: Gudhi banner
     :figclass: align-center

Introduction
************

The Python interface for the Gudhi library (Geometry Understanding in Higher
Dimensions) is a generic open source
`Python module <http://gudhi.gforge.inria.fr/python/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.
* Simplification of simplicial complexes by edge contraction.
* Algorithms to compute persistent homology and bottleneck distance.

We refer to :cite:`gudhilibrary_ICMS14` for a detailed description of the
design of the library.

Data structures
***************

Alpha complex
=============

.. include:: alpha_complex_sum.inc

Cubical complex
===============

.. include:: cubical_complex_sum.inc

Rips complex
============

.. include:: rips_complex_sum.inc

Simplex tree
============

.. include:: simplex_tree_sum.inc

Tangential complex
==================

.. include:: tangential_complex_sum.inc

Witness complex
===============

.. include:: witness_complex_sum.inc


Toolbox
*******

Bottleneck distance
===================

.. include:: bottleneck_distance_sum.inc

Persistence cohomology
======================

.. include:: persistent_cohomology_sum.inc

Persistence graphical tools
===========================

.. include:: persistence_graphical_tools_sum.inc

Bibliography
************

.. bibliography:: ../../biblio/bibliography.bib
   :filter: docnames
   :style: unsrt