summaryrefslogtreecommitdiff
path: root/src/Bottleneck_distance/utilities/README
diff options
context:
space:
mode:
Diffstat (limited to 'src/Bottleneck_distance/utilities/README')
-rw-r--r--src/Bottleneck_distance/utilities/README32
1 files changed, 26 insertions, 6 deletions
diff --git a/src/Bottleneck_distance/utilities/README b/src/Bottleneck_distance/utilities/README
index d9fdd252..04e1c4bd 100644
--- a/src/Bottleneck_distance/utilities/README
+++ b/src/Bottleneck_distance/utilities/README
@@ -1,10 +1,30 @@
-# Bottleneck_distance #
+---
+layout: page
+title: "Bottleneck distance"
+meta_title: "bottleneckdistance"
+subheadline: ""
+teaser: ""
+permalink: "/bottleneckdistance/"
+---
+{::comment}
+These flags above are here for web site generation, please let them.
+cf. https://gitlab.inria.fr/GUDHI/website
+Must be in conformity with _data/navigation.yml
+{:/comment}
+
+
+
+## bottleneck_read_file_example ##
-## `bottleneck_read_file_example` ##
This program computes the Bottleneck distance between two persistence diagram files.
-Usage:
-`bottleneck_read_file_example <file_1.pers> <file_2.pers> [<tolerance>]`
+**Usage**
+
+```
+ bottleneck_read_file_example <file_1.pers> <file_2.pers> [<tolerance>]
+```
+
where
-`<file_1.pers>` and `<file_2.pers>` must be in the format described [here](http://gudhi.gforge.inria.fr/doc/latest/fileformats.html#FileFormatsPers).
-`<tolerance>` is an error bound on the bottleneck distance (set by default to the smallest positive double value).
+
+* `<file_1.pers>` and `<file_2.pers>` must be in the format described [here](http://gudhi.gforge.inria.fr/doc/latest/fileformats.html#FileFormatsPers).
+* `<tolerance>` is an error bound on the bottleneck distance (set by default to the smallest positive double value).