summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-01-25 11:54:08 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-01-25 11:54:08 +0000
commitd674c67bdfdee94bc23a720865834ef22088679b (patch)
tree68d9bef9d6fa86f67cf50cefd656991058a98f72
parentdea1b04f72b5e77f61320e7a328d85ffbe088aa0 (diff)
Code review fix
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/rips_doc_fixes@2011 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 0f2751802f4a6f4e75dfd3dbea08d57fe081e8f9
-rw-r--r--src/Persistent_cohomology/example/rips_persistence_step_by_step.cpp7
-rw-r--r--src/Rips_complex/doc/Intro_rips_complex.h4
2 files changed, 11 insertions, 0 deletions
diff --git a/src/Persistent_cohomology/example/rips_persistence_step_by_step.cpp b/src/Persistent_cohomology/example/rips_persistence_step_by_step.cpp
index c8f0921a..b159c62e 100644
--- a/src/Persistent_cohomology/example/rips_persistence_step_by_step.cpp
+++ b/src/Persistent_cohomology/example/rips_persistence_step_by_step.cpp
@@ -34,6 +34,13 @@
#include <utility> // for pair
#include <map>
+// ----------------------------------------------------------------------------
+// rips_persistence_step_by_step is an example of each step that is required to
+// build a Rips over a Simplex_tree. Please refer to rips_persistence to see
+// how to do the same thing with the Rips_complex wrapper for less detailed
+// steps.
+// ----------------------------------------------------------------------------
+
// Types definition
using Simplex_tree = Gudhi::Simplex_tree<Gudhi::Simplex_tree_options_fast_persistence>;
using Vertex_handle = Simplex_tree::Vertex_handle;
diff --git a/src/Rips_complex/doc/Intro_rips_complex.h b/src/Rips_complex/doc/Intro_rips_complex.h
index 945027dc..4318e5da 100644
--- a/src/Rips_complex/doc/Intro_rips_complex.h
+++ b/src/Rips_complex/doc/Intro_rips_complex.h
@@ -59,6 +59,10 @@ namespace rips_complex {
* value set with \f$max(filtration(4,5), filtration(4,6), filtration(5,6))\f$.
* And so on for simplex (0,1,2,3).
*
+ * If the Rips_complex interfaces are not detailed enough for your need, please refer to
+ * <a href="_persistent_cohomology_2rips_persistence_step_by_step_8cpp-example.html">
+ * rips_persistence_step_by_step.cpp</a> example, where the graph construction over the Simplex_tree is more detailed.
+ *
* \section ripspointsdistance Point cloud and distance function
*
* \subsection ripspointscloudexample Example from a point cloud and a distance function