summaryrefslogtreecommitdiff
path: root/src/Bottleneck_distance/utilities/bottleneckdistance.md
diff options
context:
space:
mode:
authormcarrier <mcarrier@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-02-15 16:41:04 +0000
committermcarrier <mcarrier@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-02-15 16:41:04 +0000
commit69c683e663329d8410ca77c371f877bcc3bef906 (patch)
treefb18c914cf4056881b2b31875eb6b44e5ce23895 /src/Bottleneck_distance/utilities/bottleneckdistance.md
parentbe131d6f74a9264e15a0b1c1e72fa8967c4518bd (diff)
parent265484997185f3bf900744406206a2d64ca0a20d (diff)
integrated kernel code in pers_representation branch
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/kernels@3249 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 58e77263a0da3674e4699cef832b6d357dcf12e2
Diffstat (limited to 'src/Bottleneck_distance/utilities/bottleneckdistance.md')
-rw-r--r--src/Bottleneck_distance/utilities/bottleneckdistance.md18
1 files changed, 18 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..526f5822
--- /dev/null
+++ b/src/Bottleneck_distance/utilities/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).