Merge rips_complex_from_correlation_matrix branch

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

Former-commit-id: a0d98d884fc06a6528e3362d6ed627cd964f527a

1 files changed, 27 insertions, 0 deletions

diff --git a/src/Rips_complex/doc/Intro_rips_complex.h b/src/Rips_complex/doc/Intro_rips_complex.h
index 8c517516..496c4218 100644
--- a/src/Rips_complex/doc/Intro_rips_complex.h
+++ b/src/Rips_complex/doc/Intro_rips_complex.h
@@ -146,6 +146,33 @@ namespace rips_complex {
  * 
  * \include Rips_complex/full_skeleton_rips_for_doc.txt
  * 
+ * 
+ * \section ripscorrelationematrix Correlation matrix
+ * 
+ * Analogously to the case of distance matrix, Rips complexes can be also constructed based on correlation matrix. 
+ * Given a correlation matrix M, comportment-wise 1-M is a distance matrix.
+ * This example builds the one skeleton graph from the given corelation matrix and threshold value.
+ * Then it creates a `Simplex_tree` with it.
+ * 
+ * Then, it is asked to display information about the simplicial complex.
+ * 
+ * \include Rips_complex/example_one_skeleton_rips_from_correlation_matrix.cpp
+ * 
+ * When launching:
+ * 
+ * \code $> ./example_one_skeleton_from_correlation_matrix
+ * \endcode
+ *
+ * the program output is:
+ * 
+ * \include Rips_complex/one_skeleton_rips_from_correlation_matrix_for_doc.txt
+ * 
+ * All the other constructions discussed for Rips complex for distance matrix can be also performed for Rips complexes
+ * construction from correlation matrices.
+ * 
+ * @warning As persistence diagrams points will be under the diagonal, bottleneck distance and persistence graphical
+ * tool will not work properly, this is a known issue.
+ *
  */
 /** @} */  // end defgroup rips_complex