summaryrefslogtreecommitdiff
path: root/cython/doc/bottleneck_distance_sum.inc
diff options
context:
space:
mode:
Diffstat (limited to 'cython/doc/bottleneck_distance_sum.inc')
-rw-r--r--cython/doc/bottleneck_distance_sum.inc15
1 files changed, 15 insertions, 0 deletions
diff --git a/cython/doc/bottleneck_distance_sum.inc b/cython/doc/bottleneck_distance_sum.inc
new file mode 100644
index 00000000..030fad9e
--- /dev/null
+++ b/cython/doc/bottleneck_distance_sum.inc
@@ -0,0 +1,15 @@
+================================================================= =================================== ===================================
+:Author: François Godi :Introduced in: GUDHI 2.0.0 :Copyright: GPL v3
+:Requires: CGAL :math:`\geq` 4.8.0
+================================================================= =================================== ===================================
+
++-----------------------------------------------------------------+----------------------------------------------------------------------+
+| .. figure:: | Bottleneck distance measures the similarity between two persistence |
+| ../../doc/Bottleneck_distance/perturb_pd.png | diagrams. It's the shortest distance b for which there exists a |
+| :figclass: align-center | perfect matching between the points of the two diagrams (+ all the |
+| | diagonal points) such that any couple of matched points are at |
+| Bottleneck distance is the length of | distance at most b. |
+| the longest edge | |
++-----------------------------------------------------------------+----------------------------------------------------------------------+
+| :doc:`bottleneck_distance_user` | |
++-----------------------------------------------------------------+----------------------------------------------------------------------+