diff options
| author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2018-01-29 16:31:18 +0000 |
|---|---|---|
| committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2018-01-29 16:31:18 +0000 |
| commit | c2d46e0e6cfea1927875219bd5e03962cef7b010 (patch) | |
| tree | 02e557494e9af34ecb761656e0dd713be03a0327 /src/Bottleneck_distance | |
| parent | 81b06fad98ac4210c5b1d04dddeed628a8e0accb (diff) | |
Fix doc issue for utilities part on the web site
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@3176 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 3bafd9e13a5646ca93023144705d3ac7ed7c9b3a
Diffstat (limited to 'src/Bottleneck_distance')
| -rw-r--r-- | src/Bottleneck_distance/utilities/README | 32 |
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).
|