summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUlrich Bauer <mail@ulrich-bauer.org>2021-03-22 21:00:14 +0100
committerUlrich Bauer <mail@ulrich-bauer.org>2021-03-22 21:00:14 +0100
commit690f6adfaa4a9c099beeadbd6170958b453ca23c (patch)
treecdf7b1677661f44b0d531327d0260d57af7ba9f6
parent473e51092fc1938eab8543aa61299cef02050d1a (diff)
updated readme to correctly specify default file format
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index 990aa7d..9688fc8 100644
--- a/README.md
+++ b/README.md
@@ -74,9 +74,9 @@ A Makefile is provided with some variants of the above options. Use `make all` t
The input is given either in a file whose name is passed as an argument, or through stdin. The following options are supported at the command line:
- `--format`: use the specified file format for the input. The following formats are supported:
- - `lower-distance` (default if no format is specified): lower triangular distance matrix; a comma (or whitespace, or other non-numerical character) separated list of the distance matrix entries below the diagonal, sorted lexicographically by row index, then column index.
+ - `lower-distance`: lower triangular distance matrix; a comma (or whitespace, or other non-numerical character) separated list of the distance matrix entries below the diagonal, sorted lexicographically by row index, then column index.
- `upper-distance`: upper triangular distance matrix; similar to the previous, but for the entries above the diagonal; suitable for output from the MATLAB functions `pdist` or `seqpdist`, exported to a CSV file.
- - `distance`: full distance matrix; similar to the above, but for all entries of the distance matrix. One line per row of the matrix; only the part below the diagonal is actually read.
+ - `distance` (default if no format is specified): full distance matrix; similar to the above, but for all entries of the distance matrix. One line per row of the matrix; only the part below the diagonal is actually read.
- `dipha`: DIPHA distance matrix as described on the [DIPHA] website.
- `point-cloud`: point cloud; a comma (or whitespace, or other non-numerical character) separated list of coordinates of the points in some Euclidean space, one point per line.
- `binary`: lower distance matrix in binary file format; a sequence of the distance matrix entries below the diagonal in 32 bit float format (IEEE 754, single, little endian).
@@ -128,4 +128,4 @@ Ripser is licensed under the [MIT] license (`COPYING.txt`), with an extra clause
[Perseus]: <http://www.sas.upenn.edu/~vnanda/perseus/>
[GUDHI]: <http://gudhi.gforge.inria.fr>
[robinhoodhash]: <https://github.com/martinus/robin-hood-hashing>
-[MIT]: <https://opensource.org/licenses/mit-license.php> \ No newline at end of file
+[MIT]: <https://opensource.org/licenses/mit-license.php>