diff options
| author | Vincent Rouvreau <10407034+VincentRouvreau@users.noreply.github.com> | 2020-11-18 11:45:50 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-18 11:45:50 +0100 |
| commit | b28c5ca58da41aa50f084c16c8e08e77b9a18825 (patch) | |
| tree | e986157f9921aa261a58c8d812f2802cab248310 /src/python/doc/cubical_complex_user.rst | |
| parent | ad5d38986542715e0a0518537afaadcda71d9c49 (diff) | |
| parent | 8b7a25482dfd9c38825e022d5f95135f0aade738 (diff) | |
Merge pull request #386 from VincentRouvreau/tutorials_links_in_doc
Tutorials links in doc
Diffstat (limited to 'src/python/doc/cubical_complex_user.rst')
| -rw-r--r-- | src/python/doc/cubical_complex_user.rst | 22 |
1 files changed, 14 insertions, 8 deletions
diff --git a/src/python/doc/cubical_complex_user.rst b/src/python/doc/cubical_complex_user.rst index 3fd4e27a..6a211347 100644 --- a/src/python/doc/cubical_complex_user.rst +++ b/src/python/doc/cubical_complex_user.rst @@ -47,8 +47,8 @@ be a set of two elements). For further details and theory of cubical complexes, please consult :cite:`kaczynski2004computational` as well as the following paper :cite:`peikert2012topological`. -Data structure. ---------------- +Data structure +-------------- The implementation of Cubical complex provides a representation of complexes that occupy a rectangular region in :math:`\mathbb{R}^n`. This extra assumption allows for a memory efficient way of storing cubical complexes in a form @@ -77,8 +77,8 @@ Knowing the sizes of the bitmap, by a series of modulo operation, we can determi present in the product that gives the cube :math:`C`. In a similar way, we can compute boundary and the coboundary of each cube. Further details can be found in the literature. -Input Format. -------------- +Input Format +------------ In the current implantation, filtration is given at the maximal cubes, and it is then extended by the lower star filtration to all cubes. There are a number of constructors that can be used to construct cubical complex by users @@ -108,8 +108,8 @@ the program output is: Cubical complex is of dimension 2 - 49 simplices. -Periodic boundary conditions. ------------------------------ +Periodic boundary conditions +---------------------------- Often one would like to impose periodic boundary conditions to the cubical complex (cf. :doc:`periodic_cubical_complex_ref`). @@ -154,7 +154,13 @@ the program output is: Periodic cubical complex is of dimension 2 - 42 simplices. -Examples. ---------- +Examples +-------- End user programs are available in python/example/ folder. + +Tutorial +-------- + +This `notebook <https://github.com/GUDHI/TDA-tutorial/blob/master/Tuto-GUDHI-cubical-complexes.ipynb>`_ +explains how to represent sublevels sets of functions using cubical complexes.
\ No newline at end of file |