diff options
author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-11-21 08:38:45 +0000 |
---|---|---|
committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-11-21 08:38:45 +0000 |
commit | 36784120de86410bfbe51c563910df0d8718e2e9 (patch) | |
tree | c165cd33bc07e3134ce1473408ed91afb60e6e79 /src/Bottleneck_distance/utilities/README | |
parent | dc231e43e7d741e5e477de23140bf3b8982489ab (diff) | |
parent | c0c455e0afca340c70c5516ab19e0c44d961211e (diff) |
Merge add_utils_in_gudhi_v2 branch in trunk
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@2925 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 7e7153337bed2b1641bb80c6c532d07f526f5b10
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).
|