summaryrefslogtreecommitdiff
path: root/src/cython/doc/alpha_complex_sum.rst
diff options
context:
space:
mode:
Diffstat (limited to 'src/cython/doc/alpha_complex_sum.rst')
-rw-r--r--src/cython/doc/alpha_complex_sum.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/src/cython/doc/alpha_complex_sum.rst b/src/cython/doc/alpha_complex_sum.rst
new file mode 100644
index 00000000..b608050e
--- /dev/null
+++ b/src/cython/doc/alpha_complex_sum.rst
@@ -0,0 +1,21 @@
+===================================== ===================================== =====================================
+: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` |
++-------------------------------------------+----------------------------------------------------------------------+