summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVincent Rouvreau <10407034+VincentRouvreau@users.noreply.github.com>2022-12-12 14:57:46 +0100
committerGitHub <noreply@github.com>2022-12-12 14:57:46 +0100
commit55155afc5e9c9201476b9a2d9096a7ae874a27f6 (patch)
tree64c0d1a38ca380e241b1cb3fcc2e82b0cf2b8cf4
parent558e9f0fc6fa0c695c90fada9d05ec4ad05e89c5 (diff)
parent6fd61655158d0b1716a6b260e543e760eae15cb7 (diff)
Merge pull request #759 from VincentRouvreau/fix/wrong_cech_option_name
Fix option name in Cech utility documentation
-rw-r--r--src/Cech_complex/utilities/cechcomplex.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/Cech_complex/utilities/cechcomplex.md b/src/Cech_complex/utilities/cechcomplex.md
index 0e82674d..54c4e88d 100644
--- a/src/Cech_complex/utilities/cechcomplex.md
+++ b/src/Cech_complex/utilities/cechcomplex.md
@@ -36,14 +36,14 @@ where
* `-h [ --help ]` Produce help message
* `-o [ --output-file ]` Name of file in which the persistence diagram is written. Default print in standard output.
-* `-r [ --max-edge-length ]` (default = inf) Maximal length of an edge for the Čech complex construction.
+* `-r [ --max-radius ]` (default = inf) Maximal radius for the Čech complex construction.
* `-d [ --cpx-dimension ]` (default = 1) Maximal dimension of the Čech complex we want to compute.
* `-p [ --field-charac ]` (default = 11) Characteristic p of the coefficient field Z/pZ for computing homology.
* `-m [ --min-persistence ]` (default = 0) Minimal lifetime of homology feature to be recorded. Enter a negative value to see zero length intervals.
* `-e [ --exact ]` for the exact computation version.
* `-f [ --fast ]` for the fast computation version.
-Beware: this program may use a lot of RAM and take a lot of time if `max-edge-length` is set to a large value.
+Beware: this program may use a lot of RAM and take a lot of time if `max-radius` is set to a large value.
**Example 1 with Z/2Z coefficients**