diff options
Diffstat (limited to 'src/Bottleneck_distance/utilities/README')
| -rw-r--r-- | src/Bottleneck_distance/utilities/README | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/src/Bottleneck_distance/utilities/README b/src/Bottleneck_distance/utilities/README new file mode 100644 index 00000000..d9fdd252 --- /dev/null +++ b/src/Bottleneck_distance/utilities/README @@ -0,0 +1,10 @@ +# 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](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).
|