summaryrefslogtreecommitdiff
path: root/src/Witness_complex/utilities/README
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-12-06 08:13:32 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-12-06 08:13:32 +0000
commit9c0ff374057baf19d3ea1147553b68f5293074ac (patch)
tree007f17b1fd37ef7f689a63d4ebcaf9fa409d76ee /src/Witness_complex/utilities/README
parent841c4db0448687a61c25bd57729ae0cad1ae2b72 (diff)
parent86f7c676f094e44d4c06392c452b372f4470099b (diff)
Merge add_utils_in_gudhi_v2 branch after 2nd round of review
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@3041 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: ad134cc2b6756e20afc8d9db9e40c5af87d09f9d
Diffstat (limited to 'src/Witness_complex/utilities/README')
-rw-r--r--src/Witness_complex/utilities/README10
1 files changed, 6 insertions, 4 deletions
diff --git a/src/Witness_complex/utilities/README b/src/Witness_complex/utilities/README
index d8dc9ca7..1141033e 100644
--- a/src/Witness_complex/utilities/README
+++ b/src/Witness_complex/utilities/README
@@ -1,11 +1,13 @@
# Witness_complex #
+For more details about the witness complex, please read the [user manual of the package](http://gudhi.gforge.inria.fr/doc/latest/group__witness__complex.html).
+
## `weak_witness_persistence` ##
This program computes the persistent homology with coefficient field *Z/pZ* of a Weak witness complex defined on a set of input points. The output diagram contains one bar per line, written with the convention:
-`p dim b d`
+`p dim birth death`
-where `dim` is the dimension of the homological feature, `b` and `d` are respectively the birth and death of the feature, and `p` is the characteristic of the field *Z/pZ* used for homology coefficients.
+where `dim` is the dimension of the homological feature, `birth` and `death` are respectively the birth and death of the feature, and `p` is the characteristic of the field *Z/pZ* used for homology coefficients.
*Usage*
`weak_witness_persistence [options] <OFF input file>`
@@ -39,9 +41,9 @@ N.B.: output is random as the 20 landmarks are chosen randomly.
## `strong_witness_persistence` ##
This program computes the persistent homology with coefficient field *Z/pZ* of a Strong witness complex defined on a set of input points. The output diagram contains one bar per line, written with the convention:
-`p dim b d`
+`p dim birth death`
-where `dim` is the dimension of the homological feature, `b` and `d` are respectively the birth and death of the feature, and `p` is the characteristic of the field *Z/pZ* used for homology coefficients.
+where `dim` is the dimension of the homological feature, `birth` and `death` are respectively the birth and death of the feature, and `p` is the characteristic of the field *Z/pZ* used for homology coefficients.
*Usage*
`strong_witness_persistence [options] <OFF input file>`