summaryrefslogtreecommitdiff
path: root/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h
diff options
context:
space:
mode:
authorfgodi <fgodi@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-09-27 09:12:30 +0000
committerfgodi <fgodi@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-09-27 09:12:30 +0000
commitd83e3f03bafd28664bd91e59a58a1fac8081fe76 (patch)
tree15833b15fbfa4820a169376e9e670358d0bde8da /src/Bottleneck_distance/doc/Intro_bottleneck_distance.h
parent7a701f8a2326268b2aadb369fbc0848b227078a1 (diff)
more details on bottleneck distance
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/bottleneck_integration@1570 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: b784a4721fca70c5a556ef0251241ad153a2b301
Diffstat (limited to 'src/Bottleneck_distance/doc/Intro_bottleneck_distance.h')
-rw-r--r--src/Bottleneck_distance/doc/Intro_bottleneck_distance.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h b/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h
index 9a792048..8e99ad73 100644
--- a/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h
+++ b/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h
@@ -35,7 +35,11 @@ namespace bottleneck_distance {
*
* \section bottleneckdefinition Definition
*
- * Bottleneck distance is blablabla...
+ * Bottleneck distance mesures 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 (+ all the diagonal points) such that
+ * any couple of matched points are at distance at most b.
+ *
*/
/** @} */ // end defgroup bottleneck_distance