summaryrefslogtreecommitdiff
path: root/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h
diff options
context:
space:
mode:
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