From 9899ae167f281d10b1684dfcd02c6838c5bf28df Mon Sep 17 00:00:00 2001
From: Gard Spreemann <gspreemann@gmail.com>
Date: Fri, 2 Feb 2018 13:51:45 +0100
Subject: GUDHI 2.1.0 as released by upstream in a tarball.

---
 utilities/Bottleneck_distance/bottleneckdistance.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 utilities/Bottleneck_distance/bottleneckdistance.md

(limited to 'utilities/Bottleneck_distance/bottleneckdistance.md')

diff --git a/utilities/Bottleneck_distance/bottleneckdistance.md b/utilities/Bottleneck_distance/bottleneckdistance.md
new file mode 100644
index 00000000..526f5822
--- /dev/null
+++ b/utilities/Bottleneck_distance/bottleneckdistance.md
@@ -0,0 +1,18 @@
+
+
+# Bottleneck distance #
+
+## 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](/doc/latest/fileformats.html#FileFormatsPers).
+* `<tolerance>` is an error bound on the bottleneck distance (set by default to the smallest positive double value).
-- 
cgit v1.2.3