summaryrefslogtreecommitdiff
path: root/src/Persistent_cohomology/doc/Intro_persistent_cohomology.h
diff options
context:
space:
mode:
authormcarrier <mcarrier@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-04-23 20:34:49 +0000
committermcarrier <mcarrier@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-04-23 20:34:49 +0000
commitc11a8596bc7ee8705f99258886714da7757f2334 (patch)
treedd3787d1ee5c72eaef0e0215036ba5af2d9c5a81 /src/Persistent_cohomology/doc/Intro_persistent_cohomology.h
parentea11100d803c86a0fd5cfec1b9431110b48d87c9 (diff)
parentdc1a4ce409292138cf1380ca673a72eaae67675a (diff)
added unitary tests for kernels
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/kernels@3391 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: d383ed76f3cfd3724449cb7e8c24b895a7322d52
Diffstat (limited to 'src/Persistent_cohomology/doc/Intro_persistent_cohomology.h')
-rw-r--r--src/Persistent_cohomology/doc/Intro_persistent_cohomology.h13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/Persistent_cohomology/doc/Intro_persistent_cohomology.h b/src/Persistent_cohomology/doc/Intro_persistent_cohomology.h
index 4dbe82c7..3113a22c 100644
--- a/src/Persistent_cohomology/doc/Intro_persistent_cohomology.h
+++ b/src/Persistent_cohomology/doc/Intro_persistent_cohomology.h
@@ -162,6 +162,19 @@ persistence diagram with a family of field coefficients.
Rips_complex/rips_distance_matrix_persistence.cpp</a> computes the Rips complex of a distance matrix and
outputs its persistence diagram.
+The file should contain square or lower triangular distance matrix with semicolons as separators.
+The code do not check if it is dealing with a distance matrix. It is the user responsibility to provide a valid input.
+Please refer to data/distance_matrix/lower_triangular_distance_matrix.csv for an example of a file.
+
+\li <a href="_rips_complex_2rips_correlation_matrix_persistence_8cpp-example.html">
+Rips_complex/rips_correlation_matrix_persistence.cpp</a>
+computes the Rips complex of a correlation matrix and outputs its persistence diagram.
+
+Note that no check is performed if the matrix given as the input is a correlation matrix.
+It is the user responsibility to ensure that this is the case. The input is to be given either as a square or a lower
+triangular matrix.
+Please refer to data/correlation_matrix/lower_triangular_correlation_matrix.csv for an example of a file.
+
\li <a href="_alpha_complex_2alpha_complex_3d_persistence_8cpp-example.html">
Alpha_complex/alpha_complex_3d_persistence.cpp</a> computes the persistent homology with
\f$\mathbb{Z}/2\mathbb{Z}\f$ coefficients of the alpha complex on points sampling from an OFF file.