From 5ac39620529111d16e81ca8fec645228359d10e2 Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Fri, 1 Jul 2016 16:03:35 +0000 Subject: Last sphinx modifications git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/ST_cythonize@1380 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 7c7315dcf3fb211451948b67ceba499b6b7e98ca --- src/cython/doc/source/alpha_complex_ref.rst | 9 +++ src/cython/doc/source/alpha_complex_user.rst | 8 +++ src/cython/doc/source/cubical_complex_ref.rst | 9 +++ src/cython/doc/source/cubical_complex_user.rst | 8 +++ src/cython/doc/source/index.rst | 81 +++++++++++++++++++------- 5 files changed, 95 insertions(+), 20 deletions(-) create mode 100644 src/cython/doc/source/alpha_complex_ref.rst create mode 100644 src/cython/doc/source/alpha_complex_user.rst create mode 100644 src/cython/doc/source/cubical_complex_ref.rst create mode 100644 src/cython/doc/source/cubical_complex_user.rst (limited to 'src/cython/doc') diff --git a/src/cython/doc/source/alpha_complex_ref.rst b/src/cython/doc/source/alpha_complex_ref.rst new file mode 100644 index 00000000..ab81eee0 --- /dev/null +++ b/src/cython/doc/source/alpha_complex_ref.rst @@ -0,0 +1,9 @@ +Alpha complex reference manual +############################## + +.. autoclass:: gudhi.AlphaComplex + :members: + :undoc-members: + :show-inheritance: + + .. automethod:: gudhi.AlphaComplex.__init__ diff --git a/src/cython/doc/source/alpha_complex_user.rst b/src/cython/doc/source/alpha_complex_user.rst new file mode 100644 index 00000000..3b445d13 --- /dev/null +++ b/src/cython/doc/source/alpha_complex_user.rst @@ -0,0 +1,8 @@ +Alpha complex user manual +######################### + +blablabla + +.. image:: img/alpha_complex_representation.png + :align: center + diff --git a/src/cython/doc/source/cubical_complex_ref.rst b/src/cython/doc/source/cubical_complex_ref.rst new file mode 100644 index 00000000..84aa4223 --- /dev/null +++ b/src/cython/doc/source/cubical_complex_ref.rst @@ -0,0 +1,9 @@ +Cubical complex reference manual +################################ + +.. autoclass:: gudhi.CubicalComplex + :members: + :undoc-members: + :show-inheritance: + + .. automethod:: gudhi.CubicalComplex.__init__ diff --git a/src/cython/doc/source/cubical_complex_user.rst b/src/cython/doc/source/cubical_complex_user.rst new file mode 100644 index 00000000..7ade4b86 --- /dev/null +++ b/src/cython/doc/source/cubical_complex_user.rst @@ -0,0 +1,8 @@ +Cubical complex user manual +########################### + +blablabla + +.. image:: img/Cubical_complex_representation.png + :align: center + diff --git a/src/cython/doc/source/index.rst b/src/cython/doc/source/index.rst index 7dfea239..d08b465c 100644 --- a/src/cython/doc/source/index.rst +++ b/src/cython/doc/source/index.rst @@ -38,27 +38,68 @@ Data structures Alpha complex ============= -.. image:: img/alpha_complex_representation.png - :align: center - -Alpha_complex is a simplicial complex constructed from the finite cells of a -Delaunay Triangulation. - -The filtration value of each simplex is computed as the square of the -circumradius of the simplex if the circumsphere is empty (the simplex is then -said to be Gabriel), and as the minimum of the filtration values of the -codimension 1 cofaces that make it not Gabriel otherwise. All simplices that -have a filtration value strictly greater than a given alpha squared value are -not inserted into the complex. - -This package requires having CGAL version 4.7 or higher (4.8.1 is advised for -better perfomances). +===================================== ===================================== ===================================== +:Author: Vincent Rouvreau :Introduced in: GUDHI PYTHON 1.4.0 :Copyright: GPL v3 +===================================== ===================================== ===================================== + ++-------------------------------------------+----------------------------------------------------------------------+ +| .. image:: | Alpha_complex is a simplicial complex constructed from the finite | +| img/alpha_complex_representation.png | cells of a Delaunay Triangulation. | +| | | +| | The filtration value of each simplex is computed as the square of the| +| | circumradius of the simplex if the circumsphere is empty (the simplex| +| | is then said to be Gabriel), and as the minimum of the filtration | +| | values of the codimension 1 cofaces that make it not Gabriel | +| | otherwise. All simplices that have a filtration value strictly | +| | greater than a given alpha squared value are not inserted into the | +| | complex. | +| | | +| | This package requires having CGAL version 4.7 or higher (4.8.1 is | +| | advised for better perfomances). | ++-------------------------------------------+----------------------------------------------------------------------+ +| :doc:`alpha_complex_user` | :doc:`alpha_complex_ref` | ++-------------------------------------------+----------------------------------------------------------------------+ + +Cubical complex +=============== + +===================================== ===================================== ===================================== +:Author: Pawel Dlotko :Introduced in: GUDHI PYTHON 1.4.0 :Copyright: GPL v3 +===================================== ===================================== ===================================== + ++---------------------------------------------+----------------------------------------------------------------------+ +| .. image:: | The cubical complex is an example of a structured complex useful in | +| img/Cubical_complex_representation.png | computational mathematics (specially rigorous numerics) and image | +| | analysis. | ++---------------------------------------------+----------------------------------------------------------------------+ +| :doc:`cubical_complex_user` | :doc:`cubical_complex_ref` | ++---------------------------------------------+----------------------------------------------------------------------+ + +Simplex tree +============ + +===================================== ===================================== ===================================== +:Author: Clément Maria :Introduced in: GUDHI PYTHON 1.4.0 :Copyright: GPL v3 +===================================== ===================================== ===================================== + +Witness complex +=============== + +===================================== ===================================== ===================================== +:Author: Siargey Kachanovich :Introduced in: GUDHI PYTHON 1.4.0 :Copyright: GPL v3 +===================================== ===================================== ===================================== + + +Toolbox +******* + +Persistence cohomology +====================== + +===================================== ===================================== ===================================== +:Author: Clément Maria :Introduced in: GUDHI PYTHON 1.4.0 :Copyright: GPL v3 +===================================== ===================================== ===================================== -* :ref:`alphacomplex` -.. automodule:: gudhi - :members: - :undoc-members: - :show-inheritance: -- cgit v1.2.3