summaryrefslogtreecommitdiff
path: root/src/Persistent_cohomology
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-09-28 13:59:04 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-09-28 13:59:04 +0000
commitaf51e15aadd1c97da1767a2404fd1d60a105c191 (patch)
tree5019661736319dc9424e0ea56407270e4642e9cb /src/Persistent_cohomology
parentef61b085afd77976a2c7fc5dfa13bc4b293b4f95 (diff)
Fix some doc issue
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/rips_complex_from_correlation_matrix@2728 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 9a9745d18a37b53618aa3054114f26a8bdbc0009
Diffstat (limited to 'src/Persistent_cohomology')
-rw-r--r--src/Persistent_cohomology/doc/Intro_persistent_cohomology.h16
1 files changed, 9 insertions, 7 deletions
diff --git a/src/Persistent_cohomology/doc/Intro_persistent_cohomology.h b/src/Persistent_cohomology/doc/Intro_persistent_cohomology.h
index 1fe048bc..ece5e6c3 100644
--- a/src/Persistent_cohomology/doc/Intro_persistent_cohomology.h
+++ b/src/Persistent_cohomology/doc/Intro_persistent_cohomology.h
@@ -160,18 +160,20 @@ 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. The file should contain lower diagonal distance matrix with semicolons as separators.
+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="_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.
+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="_persistent_cohomology_2alpha_complex_3d_persistence_8cpp-example.html">
Persistent_cohomology/alpha_complex_3d_persistence.cpp</a> computes the persistent homology with