summaryrefslogtreecommitdiff
path: root/src/Persistent_cohomology/example/README
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2014-12-05 13:32:54 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2014-12-05 13:32:54 +0000
commit425b462d361286822ee0ed7b5fe00881ba312ea3 (patch)
treee8f641a8604418882b916573cf32c87b78d33472 /src/Persistent_cohomology/example/README
parent952b77f3b1e2415602d5d9ffc2fb7ff45cc3edc4 (diff)
Moved into trunk
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@341 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Diffstat (limited to 'src/Persistent_cohomology/example/README')
-rw-r--r--src/Persistent_cohomology/example/README47
1 files changed, 47 insertions, 0 deletions
diff --git a/src/Persistent_cohomology/example/README b/src/Persistent_cohomology/example/README
new file mode 100644
index 00000000..5dd34b85
--- /dev/null
+++ b/src/Persistent_cohomology/example/README
@@ -0,0 +1,47 @@
+To build the example, run in a Terminal:
+
+cd /path-to-example/
+cmake .
+make
+
+
+Example of use :
+
+Computation of the persistent homology with Z/2Z coefficients of the Rips complex on points
+sampling a Klein bottle:
+
+./rips_persistence ../../../data/points/Kl.txt -r 0.25 -d 3 -p 2 -m 100
+
+output:
+210 0 0 inf
+210 1 0.0702103 inf
+2 1 0.0702103 inf
+2 2 0.159992 inf
+
+with Z/3Z coefficients:
+
+./rips_persistence ../../../data/points/Kl.txt -r 0.25 -d 3 -p 3 -m 100
+
+output:
+3 0 0 inf
+3 1 0.0702103 inf
+
+and the computation with Z/2Z and Z/3Z coefficients simultaneously:
+
+./rips_multifield_persistence ../../../data/points/Kl.txt -r 0.25 -d 3 -p 2 -q 3 -m 100
+
+output:
+6 0 0 inf
+6 1 0.0702103 inf
+2 1 0.0702103 inf
+2 2 0.159992 inf
+
+and finally the computation with all Z/pZ for 2 <= p <= 71 (20 first prime numbers):
+
+ ./rips_multifield_persistence ../../../data/points/Kl.txt -r 0.25 -d 3 -p 2 -q 71 -m 100
+
+output:
+557940830126698960967415390 0 0 inf
+557940830126698960967415390 1 0.0702103 inf
+2 1 0.0702103 inf
+2 2 0.159992 inf