diff options
author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2018-06-06 09:16:00 +0000 |
---|---|---|
committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2018-06-06 09:16:00 +0000 |
commit | e64a8b5cfd08759b2e43804539db05f44c2615ad (patch) | |
tree | 32aa654885fb3c0444307625461945e6c18c536e /src/cython/doc/alpha_complex_sum.inc | |
parent | 01cfd13aa84317debb4bf681309533b693322131 (diff) |
Fix sphinx warning and issues due to new version of sphinx
Modify the doc for persistence diagram
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/python_2.1.0_fix_vincent@3543 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 3efbc052bce9a11a6b4a758f8229e91eece2a7f4
Diffstat (limited to 'src/cython/doc/alpha_complex_sum.inc')
-rw-r--r-- | src/cython/doc/alpha_complex_sum.inc | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/src/cython/doc/alpha_complex_sum.inc b/src/cython/doc/alpha_complex_sum.inc new file mode 100644 index 00000000..1680a712 --- /dev/null +++ b/src/cython/doc/alpha_complex_sum.inc @@ -0,0 +1,22 @@ +================================================================= =================================== =================================== +:Author: Vincent Rouvreau :Introduced in: GUDHI 2.0.0 :Copyright: GPL v3 +:Requires: CGAL :math:`\geq` 4.7.0 Eigen3 +================================================================= =================================== =================================== + ++----------------------------------------------------------------+------------------------------------------------------------------------+ +| .. figure:: | Alpha_complex is a simplicial complex constructed from the finite | +| ../../doc/Alpha_complex/alpha_complex_representation.png | cells of a Delaunay Triangulation. | +| :alt: Alpha complex representation | | +| :figclass: align-center | The filtration value of each simplex is computed as the square of the | +| | circumradius of the simplex if the circumsphere is empty (the simplex | +| Alpha complex representation | 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 performance). | ++----------------------------------------------------------------+------------------------------------------------------------------------+ +| :doc:`alpha_complex_user` | :doc:`alpha_complex_ref` | ++----------------------------------------------------------------+------------------------------------------------------------------------+ |