summaryrefslogtreecommitdiff
path: root/src/python/doc/bottleneck_distance_user.rst
diff options
context:
space:
mode:
authorMarc Glisse <marc.glisse@inria.fr>2020-06-01 15:24:28 +0200
committerMarc Glisse <marc.glisse@inria.fr>2020-06-01 15:24:28 +0200
commit4aff8dc700a0790373d82ae24076359c09ee04c8 (patch)
tree7769285a8f5706e883cf0f56aadaa68e06b68f91 /src/python/doc/bottleneck_distance_user.rst
parentc53567c85f936f78000471fcee6234e75f7742ca (diff)
Interface for hera's bottleneck_distance
Diffstat (limited to 'src/python/doc/bottleneck_distance_user.rst')
-rw-r--r--src/python/doc/bottleneck_distance_user.rst18
1 files changed, 13 insertions, 5 deletions
diff --git a/src/python/doc/bottleneck_distance_user.rst b/src/python/doc/bottleneck_distance_user.rst
index 89da89d3..49bd3706 100644
--- a/src/python/doc/bottleneck_distance_user.rst
+++ b/src/python/doc/bottleneck_distance_user.rst
@@ -9,14 +9,22 @@ 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>`_.
-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.
+
+Beware that its approximation allows for a multiplicative error, while the function above uses an additive error.
+
+.. autofunction:: gudhi.hera.bottleneck_distance
+
+
Distance computation
--------------------