From 6dbf0ab8f84fd57d4fb80cd3c1bcf0aca6f0bb05 Mon Sep 17 00:00:00 2001
From: cjamin <cjamin@636b058d-ea47-450e-bf9e-a15bfbe3eedb>
Date: Wed, 15 Nov 2017 15:57:48 +0000
Subject: Doc

git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/add_utils_in_gudhi_v2@2884 636b058d-ea47-450e-bf9e-a15bfbe3eedb

Former-commit-id: c5e0a65a484a71d8a9fc1fc2b695dd20a367fd0c
---
 src/Alpha_complex/utilities/CMakeLists.txt |  4 ++--
 src/Alpha_complex/utilities/README         | 17 +++++++++++++++++
 2 files changed, 19 insertions(+), 2 deletions(-)

(limited to 'src/Alpha_complex')

diff --git a/src/Alpha_complex/utilities/CMakeLists.txt b/src/Alpha_complex/utilities/CMakeLists.txt
index 120ca416..18699650 100644
--- a/src/Alpha_complex/utilities/CMakeLists.txt
+++ b/src/Alpha_complex/utilities/CMakeLists.txt
@@ -17,9 +17,9 @@ if(CGAL_FOUND)
   
   add_test(NAME Alpha_complex_utilities_alpha_complex_3d_persistence COMMAND $<TARGET_FILE:alpha_complex_3d_persistence>
       "${CMAKE_SOURCE_DIR}/data/points/tore3D_300.off" "2" "0.45")
-  add_test(NAME Persistent_cohomology_example_exact_alpha_complex_3d COMMAND $<TARGET_FILE:exact_alpha_complex_3d_persistence>
+  add_test(NAME Alpha_complex_utilities_exact_alpha_complex_3d COMMAND $<TARGET_FILE:exact_alpha_complex_3d_persistence>
       "${CMAKE_SOURCE_DIR}/data/points/tore3D_300.off" "2" "0.45")
-  add_test(NAME Persistent_cohomology_example_weighted_alpha_complex_3d COMMAND $<TARGET_FILE:weighted_alpha_complex_3d_persistence>
+  add_test(NAME Alpha_complex_utilities_weighted_alpha_complex_3d COMMAND $<TARGET_FILE:weighted_alpha_complex_3d_persistence>
       "${CMAKE_SOURCE_DIR}/data/points/tore3D_300.off" "${CMAKE_SOURCE_DIR}/data/points/tore3D_300.weights" "2" "0.45")
 
   install(TARGETS alpha_complex_3d_persistence DESTINATION bin)
diff --git a/src/Alpha_complex/utilities/README b/src/Alpha_complex/utilities/README
index 67ea1875..6e7d16b7 100644
--- a/src/Alpha_complex/utilities/README
+++ b/src/Alpha_complex/utilities/README
@@ -39,6 +39,23 @@ N.B.:
 
 
 
+## `exact_alpha_complex_3d_persistence` ##
+Same as `alpha_complex_3d_persistence`, but using exact computation. It is slower, but it is necessary when points are on a grid for instance.
+
+
+
+## `weighted_alpha_complex_3d_persistence` ##
+Same as `alpha_complex_3d_persistence`, but using weighted points.
+
+**Usage**
+`weighted_alpha_complex_3d_persistence <input OFF file> <input weights file> <p> <min_persistence>` 
+where
+`<input OFF file>` is the path to the input point cloud in OFF format.
+`<input weights file>` is the path to the file containing the weights of the points (one value per line).
+`<p>` is the characteristic p of the coefficient field *Z/pZ* for computing homology. It must be a stricly positive integer.
+`<min_persistence>` is the minimal lifetime of homology feature to be recorded. Enter a negative value to see zero length intervals.
+
+
 
 ## `periodic_alpha_complex_3d_persistence` ##
 This program computes the persistent homology with coefficient field Z/pZ of the 3D periodic alpha complex built from a 3D point cloud. The output diagram contains one bar per line, written with the convention:
-- 
cgit v1.2.3