summaryrefslogtreecommitdiff
path: root/src/Rips_complex/doc
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-12-12 16:52:02 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-12-12 16:52:02 +0000
commit04e1b011959f93de8a7a252cdc9fa1f4aed0c12e (patch)
tree64454e4f4910941d0238734957f8f2eb47a15f8b /src/Rips_complex/doc
parent911370db9608601cce5aaf9ec91f2a0ca08eb9d7 (diff)
Doc fix from review
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/distance_matrix_in_rips_module@1857 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 88619abff993bd776310f18034d2ab5fa0b41944
Diffstat (limited to 'src/Rips_complex/doc')
-rw-r--r--src/Rips_complex/doc/Intro_rips_complex.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/src/Rips_complex/doc/Intro_rips_complex.h b/src/Rips_complex/doc/Intro_rips_complex.h
index 0ae89ffc..5b424a26 100644
--- a/src/Rips_complex/doc/Intro_rips_complex.h
+++ b/src/Rips_complex/doc/Intro_rips_complex.h
@@ -37,10 +37,13 @@ namespace rips_complex {
*
* Rips_complex
* <a target="_blank" href="https://en.wikipedia.org/wiki/Vietoris%E2%80%93Rips_complex">(Wikipedia)</a> is a
+ * one skeleton graph that allows to construct a
* <a target="_blank" href="https://en.wikipedia.org/wiki/Simplicial_complex">simplicial complex</a>
- * constructed from a one skeleton graph.
+ * from it.
+ * The input can be a point cloud with a given distance function, or a distance matrix.
*
- * The filtration value of each edge is computed from a user-given distance function.
+ * The filtration value of each edge is computed from a user-given distance function, or directly from the distance
+ * matrix.
*
* All edges that have a filtration value strictly greater than a given threshold value are not inserted into
* the complex.
@@ -77,7 +80,7 @@ namespace rips_complex {
*
* \subsection ripsoffexample Example from OFF file
*
- * This example builds the one skeleton graph from the given points in an OFF file, threshold value, and distance
+ * This example builds the Rips_complex from the given points in an OFF file, threshold value, and distance
* function.
* Then it creates a `Simplex_tree` with it.
*