summaryrefslogtreecommitdiff
path: root/src/python/doc/bottleneck_distance_user.rst
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-06-16 21:16:17 +0200
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-06-16 21:16:17 +0200
commit3dd89cf0e7c47b98e150d32ede46e0f4514f5e2b (patch)
tree6ae8a16ee7f00e4d6802440fbc7abb764dfe72c2 /src/python/doc/bottleneck_distance_user.rst
parent8014dac407f1cce2ce4082902adb1409e4987013 (diff)
parenta12d1451d1413444319ccdc24bfacaae35012ce0 (diff)
Merge branch 'master' into alpha_complex_3d_python
Diffstat (limited to 'src/python/doc/bottleneck_distance_user.rst')
-rw-r--r--src/python/doc/bottleneck_distance_user.rst19
1 files changed, 14 insertions, 5 deletions
diff --git a/src/python/doc/bottleneck_distance_user.rst b/src/python/doc/bottleneck_distance_user.rst
index 89da89d3..6c6e08d9 100644
--- a/src/python/doc/bottleneck_distance_user.rst
+++ b/src/python/doc/bottleneck_distance_user.rst
@@ -9,14 +9,23 @@ Definition
.. include:: bottleneck_distance_sum.inc
-This implementation is based on ideas from "Geometry Helps in Bottleneck Matching and Related Problems"
-:cite:`DBLP:journals/algorithmica/EfratIK01`. Another relevant publication, although it was not used is
-"Geometry Helps to Compare Persistence Diagrams" :cite:`Kerber:2017:GHC:3047249.3064175`.
+This implementation by François Godi is based on ideas from "Geometry Helps in Bottleneck Matching and Related Problems"
+:cite:`DBLP:journals/algorithmica/EfratIK01` and requires `CGAL <installation.html#cgal>`_ (`GPL v3 </licensing/>`_).
-Function
---------
.. autofunction:: gudhi.bottleneck_distance
+This other implementation comes from `Hera
+<https://bitbucket.org/grey_narn/hera/src/master/>`_ (BSD-3-Clause) which is
+based on "Geometry Helps to Compare Persistence Diagrams"
+:cite:`Kerber:2017:GHC:3047249.3064175` by Michael Kerber, Dmitriy
+Morozov, and Arnur Nigmetov.
+
+.. warning::
+ Beware that its approximation allows for a multiplicative error, while the function above uses an additive error.
+
+.. autofunction:: gudhi.hera.bottleneck_distance
+
+
Distance computation
--------------------