summaryrefslogtreecommitdiff
path: root/src/Persistent_cohomology/doc/Intro_persistent_cohomology.h
diff options
context:
space:
mode:
authorpdlotko <pdlotko@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-09-25 20:14:45 +0000
committerpdlotko <pdlotko@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-09-25 20:14:45 +0000
commit1d611ca664d78d3b0b53264c52b04a8396383140 (patch)
tree709e925004a0054b34c52d41f25bc15487ac1627 /src/Persistent_cohomology/doc/Intro_persistent_cohomology.h
parentf56b1ef562894f3bec4e2616998b9e7dfefe56af (diff)
Adding all that is needed for Rips complex construction from correlation matrix.
Moduo the fact that I cannot see the doc (althoug make doxygen do not create any errors), this is ready for review. git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/rips_complex_from_correlation_matrix@2712 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: e8e7acceaf2be6f17baa3d77c85e207a74a4fb33
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, 12 insertions, 1 deletions
diff --git a/src/Persistent_cohomology/doc/Intro_persistent_cohomology.h b/src/Persistent_cohomology/doc/Intro_persistent_cohomology.h
index e17e5926..1fe048bc 100644
--- a/src/Persistent_cohomology/doc/Intro_persistent_cohomology.h
+++ b/src/Persistent_cohomology/doc/Intro_persistent_cohomology.h
@@ -160,7 +160,18 @@ persistence diagram with a family of field coefficients.
\li <a href="_persistent_cohomology_2rips_distance_matrix_persistence_8cpp-example.html">
Persistent_cohomology/rips_distance_matrix_persistence.cpp</a> computes the Rips complex of a distance matrix and
-outputs its persistence diagram.
+outputs its persistence diagram. The file should contain lower diagonal 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="_persistent_cohomology_2rips_correlation_matrix_persistence_8cpp-example.html">
+Persistent_cohomology/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 lower triangular matrix.
+Please refer to data/distance_matrix/lower_triangular_correlation_matrix.csv for an example of a file.
\li <a href="_persistent_cohomology_2alpha_complex_3d_persistence_8cpp-example.html">
Persistent_cohomology/alpha_complex_3d_persistence.cpp</a> computes the persistent homology with