summaryrefslogtreecommitdiff
path: root/src/Bottleneck_distance
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
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')
-rw-r--r--src/Bottleneck_distance/doc/Intro_bottleneck_distance.h5
-rw-r--r--src/Bottleneck_distance/doc/bottleneck_distance_example.ipe8
-rw-r--r--src/Bottleneck_distance/doc/bottleneck_distance_example.pngbin21465 -> 19485 bytes
3 files changed, 7 insertions, 6 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>
diff --git a/src/Bottleneck_distance/doc/bottleneck_distance_example.ipe b/src/Bottleneck_distance/doc/bottleneck_distance_example.ipe
index 9dc5420e..2033ea56 100644
--- a/src/Bottleneck_distance/doc/bottleneck_distance_example.ipe
+++ b/src/Bottleneck_distance/doc/bottleneck_distance_example.ipe
@@ -1,7 +1,7 @@
<?xml version="1.0"?>
<!DOCTYPE ipe SYSTEM "ipe.dtd">
<ipe version="70206" creator="Ipe 7.2.7">
-<info created="D:20190606115351" modified="D:20190606115351"/>
+<info created="D:20190606115351" modified="D:20190607172542"/>
<ipestyle name="basic">
<symbol name="arrow/arc(spx)">
<path stroke="sym-stroke" fill="sym-stroke" pen="sym-pen">
@@ -220,13 +220,13 @@ h
<dashstyle name="dash dotted" value="[4 2 1 2] 0"/>
<dashstyle name="dash dot dotted" value="[4 2 1 2 1 2] 0"/>
<textsize name="large" value="\large"/>
+<textsize name="small" value="\small"/>
+<textsize name="tiny" value="\tiny"/>
<textsize name="Large" value="\Large"/>
<textsize name="LARGE" value="\LARGE"/>
<textsize name="huge" value="\huge"/>
<textsize name="Huge" value="\Huge"/>
-<textsize name="small" value="\small"/>
<textsize name="footnote" value="\footnotesize"/>
-<textsize name="tiny" value="\tiny"/>
<textstyle name="center" begin="\begin{center}" end="\end{center}"/>
<textstyle name="itemize" begin="\begin{itemize}" end="\end{itemize}"/>
<textstyle name="item" begin="\begin{itemize}\item{}" end="\end{itemize}"/>
@@ -274,7 +274,7 @@ h
224 320 l
</path>
<text matrix="1 0 0 1 -32 8" transformations="translations" pos="164 248" stroke="red" type="label" width="23.8" height="7.473" depth="2.49" valign="baseline">(0, 0)</text>
-<text matrix="1 0 0 1 -4 4" transformations="translations" pos="132 356" stroke="navy" type="label" width="28.781" height="7.473" depth="2.49" valign="baseline">(13, 0)</text>
+<text matrix="1 0 0 1 -4 4" transformations="translations" pos="132 356" stroke="navy" type="label" width="28.781" height="7.473" depth="2.49" valign="baseline">(0, 13)</text>
<text transformations="translations" pos="216 300" stroke="black" type="label" width="39.297" height="7.473" depth="2.49" valign="baseline">(6.5, 6.5)</text>
<path stroke="black" arrow="normal/normal" rarrow="normal/normal">
160.433 359.995 m
diff --git a/src/Bottleneck_distance/doc/bottleneck_distance_example.png b/src/Bottleneck_distance/doc/bottleneck_distance_example.png
index b56ee791..1d3b91aa 100644
--- a/src/Bottleneck_distance/doc/bottleneck_distance_example.png
+++ b/src/Bottleneck_distance/doc/bottleneck_distance_example.png
Binary files differ