small modif to avoid assert on compute_PD()

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

Former-commit-id: b0e73b4e1e77743419b06d142467ebfceacf83cf

1 files changed, 14 insertions, 2 deletions

diff --git a/src/Persistent_cohomology/doc/Intro_persistent_cohomology.h b/src/Persistent_cohomology/doc/Intro_persistent_cohomology.h
index ceaea505..5fb9d4d2 100644
--- a/src/Persistent_cohomology/doc/Intro_persistent_cohomology.h
+++ b/src/Persistent_cohomology/doc/Intro_persistent_cohomology.h
@@ -4,7 +4,7 @@
  *
  *    Author(s):       Clément Maria
  *
- *    Copyright (C) 2014  INRIA Sophia Antipolis-Méditerranée (France)
+ *    Copyright (C) 2014 Inria
  *
  *    This program is free software: you can redistribute it and/or modify
  *    it under the terms of the GNU General Public License as published by
@@ -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.
@@ -248,7 +261,6 @@ Simplex_tree dim: 3
 Persistent_cohomology/plain_homology.cpp</a> computes the plain homology of a simple simplicial complex without
 filtration values.
 
- \copyright GNU General Public License v3.
  */
 
 }  // namespace persistent_cohomology