diff options
| author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2018-01-29 16:34:16 +0000 |
|---|---|---|
| committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2018-01-29 16:34:16 +0000 |
| commit | c50ac9a8e5d1f506cc79b9c1e623228fffd545bf (patch) | |
| tree | 894e41f3f685000c95b54456bbdb935daaf1084d /src/Bottleneck_distance/utilities/bottleneckdistance.md | |
| parent | c2d46e0e6cfea1927875219bd5e03962cef7b010 (diff) | |
Rename README files for web site generation conformity
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@3177 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 632b264790c30accb42e731c4a4f6744a2f7ba11
Diffstat (limited to 'src/Bottleneck_distance/utilities/bottleneckdistance.md')
| -rw-r--r-- | src/Bottleneck_distance/utilities/bottleneckdistance.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/src/Bottleneck_distance/utilities/bottleneckdistance.md b/src/Bottleneck_distance/utilities/bottleneckdistance.md new file mode 100644 index 00000000..04e1c4bd --- /dev/null +++ b/src/Bottleneck_distance/utilities/bottleneckdistance.md @@ -0,0 +1,30 @@ +---
+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 ##
+
+This program computes the Bottleneck distance between two persistence diagram files.
+
+**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).
|