summaryrefslogtreecommitdiff
path: root/src/Bottleneck_distance/doc
diff options
context:
space:
mode:
authorfgodi <fgodi@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-12-16 12:44:11 +0000
committerfgodi <fgodi@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-12-16 12:44:11 +0000
commit5cc424d34f304fad2a8b462156672e2af25ab756 (patch)
treee55668397d718a44044bcc47db8bbc412f83844f /src/Bottleneck_distance/doc
parent66c657a9b422474a1a151fea2ba711b377dce57f (diff)
intro documentation
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/bottleneck_integration@1898 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 2aae46574350bb2240f83e183d471965c933fe0b
Diffstat (limited to 'src/Bottleneck_distance/doc')
-rw-r--r--src/Bottleneck_distance/doc/Intro_bottleneck_distance.h7
1 files changed, 3 insertions, 4 deletions
diff --git a/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h b/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h
index 1f443f7f..ebe1123b 100644
--- a/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h
+++ b/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h
@@ -35,12 +35,11 @@ namespace bottleneck_distance {
*
* \section bottleneckdefinition Definition
*
- * Bottleneck distance measures the similarity between two persistence diagrams.
- * It's the shortest distance b for which there exists a perfect matching between
- * the points of the two diagrams (and also all the points of the diagonal) such that
+ * The bottleneck distance measures the similarity between two persistence diagrams. It's 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.
*
- * \image html perturb_pd.png Bottleneck distance is the length of the longest edge on this picture.
+ * \image html perturb_pd.png On this picture, the red edges represent the matching. The bottleneck distance is the length of the longest edge.
*
*/
/** @} */ // end defgroup bottleneck_distance