summaryrefslogtreecommitdiff
path: root/src/Rips_complex
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-12-16 10:22:49 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-12-16 10:22:49 +0000
commit8340ca1acd568c93d115fcd46a996749a8cc295d (patch)
tree3b4c63ea6bd4089034157b7c07819c31bf49f2de /src/Rips_complex
parent08bfe7735e33efbd81b3fd58e8bc34e3228baa3b (diff)
Modify documentatin after review
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/distance_matrix_in_rips_module@1894 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 4bd2b575d6f58aab2ea1d03b20d3e06693bec182
Diffstat (limited to 'src/Rips_complex')
-rw-r--r--src/Rips_complex/concept/Simplicial_complex_for_rips.h6
-rw-r--r--src/Rips_complex/doc/Intro_rips_complex.h2
2 files changed, 5 insertions, 3 deletions
diff --git a/src/Rips_complex/concept/Simplicial_complex_for_rips.h b/src/Rips_complex/concept/Simplicial_complex_for_rips.h
index ba9a2f5e..08173289 100644
--- a/src/Rips_complex/concept/Simplicial_complex_for_rips.h
+++ b/src/Rips_complex/concept/Simplicial_complex_for_rips.h
@@ -34,11 +34,13 @@ struct SimplicialComplexForRips {
/** \brief Handle to specify the simplex filtration value. */
typedef unspecified Filtration_value;
- /** \brief Inserts a given range `Gudhi::rips_complex::Rips_complex::OneSkeletonGraph` in the simplicial complex. */
+ /** \brief Inserts a given range `Gudhi::rips_complex::Rips_complex::OneSkeletonGraph` in the simplicial
+ * complex. */
template<class OneSkeletonGraph>
void insert_graph(const OneSkeletonGraph& skel_graph);
- /** \brief Expands the simplicial complex containing only its one skeleton until a given maximal dimension. */
+ /** \brief Expands the simplicial complex containing only its one skeleton until a given maximal dimension as
+ * defined in \ref ripsdefinition. */
void expansion(int max_dim);
/** \brief Returns the number of vertices in the simplicial complex. */
diff --git a/src/Rips_complex/doc/Intro_rips_complex.h b/src/Rips_complex/doc/Intro_rips_complex.h
index 5b424a26..8bacd0e7 100644
--- a/src/Rips_complex/doc/Intro_rips_complex.h
+++ b/src/Rips_complex/doc/Intro_rips_complex.h
@@ -33,7 +33,7 @@ namespace rips_complex {
*
* @{
*
- * \section ripsdefinition Definition
+ * \section ripsdefinition Rips complex definition
*
* Rips_complex
* <a target="_blank" href="https://en.wikipedia.org/wiki/Vietoris%E2%80%93Rips_complex">(Wikipedia)</a> is a