diff options
author | Gard Spreemann <gspr@nonempty.org> | 2019-10-30 16:12:30 +0100 |
---|---|---|
committer | Gard Spreemann <gspr@nonempty.org> | 2019-10-30 16:12:30 +0100 |
commit | 0caf6d61ac80553bfe4d9cbbfab2e6b61aaf618d (patch) | |
tree | 0d3f55d74525bc09b4b9ddbde8ad91009cce5a6d /debian | |
parent | ef8afcea5657382e293df473c4c56578601af42d (diff) |
Man pages.
Diffstat (limited to 'debian')
-rw-r--r-- | debian/ripser-coeff.1 | 42 | ||||
-rw-r--r-- | debian/ripser.1 | 37 | ||||
-rw-r--r-- | debian/ripser.manpages | 2 |
3 files changed, 81 insertions, 0 deletions
diff --git a/debian/ripser-coeff.1 b/debian/ripser-coeff.1 new file mode 100644 index 0000000..3d94831 --- /dev/null +++ b/debian/ripser-coeff.1 @@ -0,0 +1,42 @@ +.TH RIPSER-COEFF 1 +.SH NAME +ripser-coeff \- fast computation of persistent homology of flag complexes +.SH SYNOPSIS +.B ripser-coeff +[\fB\-\-help\fR] +[\fB\-\-format\fR \fIformat\fR] +[\fB\-\-dim \fIk\fR] +[\fB\-\-threshold \fIt\fR] +[\fB\-\-ratio \fIr\fR] +[\fB\-\-modulus \fIp\fR] +[\fIfilename\fR] +.SH DESCRIPTION +.B ripser-coeff +computes persistent homology of flag complexes (such as Vietoris-Rips +complexes) only, allowing significant gains in computation time and +memory usage over the general situation. Unlike \fBripser\fR, it +computes over an arbitrary finite field. + +See https://arxiv.org/abs/1908.02518 for details. +.SH OPTIONS +.TP +\fB\-\-help\fR +Display help. +.TP +\fB\-\-format\fR \fIformat\fR +Specify input format. See \fB\-\-help\fR for a full list. +.TP +\fB\-\-dim \fIk\fR +Compute persistent homology up to dimension \fIk\fR. +.TP +\fB\-\-threshold \fIt\fR +Compute Rips complexes up to diameter \fIt\fR. +.TP +\fB\-\-ratio \fIr\fR +Only show persistence pairs with death/birth ratio > \fIr\fR. +.TP +\fB\-\-modulus \fIp\fR +Compute homology with coefficients in the prime field Z/\fIp\fRZ. +.TP +\fIfilename\fR +Read input from this file. Uses stdin if not present. diff --git a/debian/ripser.1 b/debian/ripser.1 new file mode 100644 index 0000000..9caafee --- /dev/null +++ b/debian/ripser.1 @@ -0,0 +1,37 @@ +.TH RIPSER 1 +.SH NAME +ripser \- fast computation of persistent homology of flag complexes +.SH SYNOPSIS +.B ripser +[\fB\-\-help\fR] +[\fB\-\-format\fR \fIformat\fR] +[\fB\-\-dim \fIk\fR] +[\fB\-\-threshold \fIt\fR] +[\fB\-\-ratio \fIr\fR] +[\fIfilename\fR] +.SH DESCRIPTION +.B ripser +computes persistent homology of flag complexes (such as Vietoris-Rips +complexes) only, allowing significant gains in computation time and +memory usage over the general situation. + +See https://arxiv.org/abs/1908.02518 for details. +.SH OPTIONS +.TP +\fB\-\-help\fR +Display help. +.TP +\fB\-\-format\fR \fIformat\fR +Specify input format. See \fB\-\-help\fR for a full list. +.TP +\fB\-\-dim \fIk\fR +Compute persistent homology up to dimension \fIk\fR. +.TP +\fB\-\-threshold \fIt\fR +Compute Rips complexes up to diameter \fIt\fR. +.TP +\fB\-\-ratio \fIr\fR +Only show persistence pairs with death/birth ratio > \fIr\fR. +.TP +\fIfilename\fR +Read input from this file. Uses stdin if not present. diff --git a/debian/ripser.manpages b/debian/ripser.manpages new file mode 100644 index 0000000..6c82f0f --- /dev/null +++ b/debian/ripser.manpages @@ -0,0 +1,2 @@ +debian/ripser.1 +debian/ripser-coeff.1 |