From af51e15aadd1c97da1767a2404fd1d60a105c191 Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Thu, 28 Sep 2017 13:59:04 +0000 Subject: 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 --- .../doc/Intro_persistent_cohomology.h | 16 +++++++++------- src/cython/doc/rips_complex_user.rst | 2 +- 2 files changed, 10 insertions(+), 8 deletions(-) (limited to 'src') 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 Persistent_cohomology/rips_distance_matrix_persistence.cpp 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 Persistent_cohomology/rips_correlation_matrix_persistence.cpp -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 Persistent_cohomology/alpha_complex_3d_persistence.cpp computes the persistent homology with diff --git a/src/cython/doc/rips_complex_user.rst b/src/cython/doc/rips_complex_user.rst index f0e7bf2d..b80ff7fe 100644 --- a/src/cython/doc/rips_complex_user.rst +++ b/src/cython/doc/rips_complex_user.rst @@ -197,7 +197,7 @@ Example from csv file ^^^^^^^^^^^^^^^^^^^^^ This example builds the :doc:`Rips_complex ` from the given -points in an OFF file, and max_edge_length value. +distance matrix in a csv file, and max_edge_length value. Then it creates a :doc:`Simplex_tree ` with it. Finally, it is asked to display information about the Rips complex. -- cgit v1.2.3