summaryrefslogtreecommitdiff
path: root/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2019-06-07 17:27:29 +0200
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2019-06-07 17:27:29 +0200
commit4b401e9a51cbcbb44d47f4819b57ec7787088df4 (patch)
tree787a1a16f7057c5c589cbb2d1f34882557a13dc8 /src/Bottleneck_distance/doc/Intro_bottleneck_distance.h
parentcb890f276bc5327ebad1e1fcd1cc05a0d300de83 (diff)
Fix doc review. Add citations for python doc version. Replace (13,0) with (0,13) in figure
Diffstat (limited to 'src/Bottleneck_distance/doc/Intro_bottleneck_distance.h')
-rw-r--r--src/Bottleneck_distance/doc/Intro_bottleneck_distance.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h b/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h
index 520aab4f..7cb0752e 100644
--- a/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h
+++ b/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h
@@ -40,7 +40,8 @@ namespace persistence_diagram {
*
* The bottleneck distance measures the similarity between two persistence diagrams. It is the shortest distance b for
* which there exists a perfect matching between the points of the two diagrams (completed with all the points on the
- * diagonal in order to ignore cardinality mismatchs) such that any couple of matched points are at distance at most b.
+ * diagonal in order to ignore cardinality mismatchs) such that any couple of matched points are at distance at most b,
+ * where the distance between points is the sup norm in \f$\mathbb{R}^2\f$ (not the Euclidean distance).
*
* \image html perturb_pd.png On this picture, the red edges represent the matching. The bottleneck distance is the length of the longest edge.
*
@@ -50,7 +51,7 @@ namespace persistence_diagram {
*
* \section bottleneckdistanceprecision Distance computation
*
- * Bottleneck distance does not use Euclidean distance, like explained in the following example:
+ * The following example explains how the distance is computed:
*
* \code{.cpp}
#include <gudhi/Bottleneck.h>