summaryrefslogtreecommitdiff
path: root/src/cython/doc/bottleneck_distance_sum.rst
diff options
context:
space:
mode:
Diffstat (limited to 'src/cython/doc/bottleneck_distance_sum.rst')
-rw-r--r--src/cython/doc/bottleneck_distance_sum.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/src/cython/doc/bottleneck_distance_sum.rst b/src/cython/doc/bottleneck_distance_sum.rst
new file mode 100644
index 00000000..6cffa122
--- /dev/null
+++ b/src/cython/doc/bottleneck_distance_sum.rst
@@ -0,0 +1,15 @@
+===================================== ===================================== =====================================
+:Author: Francois Godi :Introduced in: GUDHI 1.4.0 :Copyright: GPL v3
+===================================== ===================================== =====================================
+:Requires: CGAL ≥ 4.8.0
+===================================== ===================================== =====================================
+
++-------------------------------------------+----------------------------------------------------------------------+
+| .. image:: | Bottleneck distance measures the similarity between two persistence |
+| img/perturb_pd.png | diagrams. It's the shortest distance b for which there exists a |
+| | perfect matching between the points of the two diagrams (+ all the |
+| | diagonal points) such that any couple of matched points are at |
+| | distance at most b. |
++-------------------------------------------+----------------------------------------------------------------------+
+| :doc:`bottleneck_distance_user` | :doc:`bottleneck_distance_ref` |
++-------------------------------------------+----------------------------------------------------------------------+