diff options
| author | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2019-06-07 17:27:29 +0200 |
|---|---|---|
| committer | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2019-06-07 17:27:29 +0200 |
| commit | 4b401e9a51cbcbb44d47f4819b57ec7787088df4 (patch) | |
| tree | 787a1a16f7057c5c589cbb2d1f34882557a13dc8 /src/cython | |
| parent | cb890f276bc5327ebad1e1fcd1cc05a0d300de83 (diff) | |
Fix doc review. Add citations for python doc version. Replace (13,0) with (0,13) in figure
Diffstat (limited to 'src/cython')
| -rw-r--r-- | src/cython/doc/bottleneck_distance_sum.inc | 4 | ||||
| -rw-r--r-- | src/cython/doc/bottleneck_distance_user.rst | 10 |
2 files changed, 9 insertions, 5 deletions
diff --git a/src/cython/doc/bottleneck_distance_sum.inc b/src/cython/doc/bottleneck_distance_sum.inc index 41b9c5a3..6840e838 100644 --- a/src/cython/doc/bottleneck_distance_sum.inc +++ b/src/cython/doc/bottleneck_distance_sum.inc @@ -6,8 +6,8 @@ | ../../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 | :Introduced in: GUDHI 2.0.0 | | | diagonal points) such that any couple of matched points are at | | - | Bottleneck distance is the length of | distance at most b. | :Copyright: GPL v3 | - | the longest edge | | | + | Bottleneck distance is the length of | distance at most b, where the distance between points is the sup | :Copyright: GPL v3 | + | the longest edge | norm in :math:`\mathbb{R}^2`. | | | | | :Requires: CGAL :math:`\geq` 4.8.0 | +-----------------------------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------+ | * :doc:`bottleneck_distance_user` | | diff --git a/src/cython/doc/bottleneck_distance_user.rst b/src/cython/doc/bottleneck_distance_user.rst index a6a4426f..9435c7f1 100644 --- a/src/cython/doc/bottleneck_distance_user.rst +++ b/src/cython/doc/bottleneck_distance_user.rst @@ -9,6 +9,10 @@ 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`. + Function -------- .. autofunction:: gudhi.bottleneck_distance @@ -16,7 +20,7 @@ Function Distance computation -------------------- -Bottleneck distance does not use Euclidean distance, like explained in the following example: +The following example explains how the distance is computed: .. testcode:: @@ -33,14 +37,14 @@ Bottleneck distance does not use Euclidean distance, like explained in the follo ../../doc/Bottleneck_distance/bottleneck_distance_example.png :figclass: align-center - The point (0, 13) is at 6.5 distance from the diagonal and more + The point (0, 13) is at distance 6.5 from the diagonal and more specifically from the point (6.5, 6.5) Basic example ------------- -This another example computes the bottleneck distance from 2 persistence diagrams: +This other example computes the bottleneck distance from 2 persistence diagrams: .. testcode:: |