summaryrefslogtreecommitdiff
path: root/src/cython/doc/bottleneck_distance_sum.rst
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-01-27 17:10:54 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-01-27 17:10:54 +0000
commitfee58180eb9e2617f92e2f92bb6d1120348f310f (patch)
tree79a279ea42c0e3e8105746ca145999e59f717165 /src/cython/doc/bottleneck_distance_sum.rst
parent88a606bd964144d8045fe91debbfcc77064a73a2 (diff)
Add bottleneck distance
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/ST_cythonize@2019 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 1320379f3d41ef4d11326c1aad1dd20469d3f4e0
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 &ge; 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` |
++-------------------------------------------+----------------------------------------------------------------------+