summaryrefslogtreecommitdiff
path: root/src/Rips_complex/doc
diff options
context:
space:
mode:
authorglisse <glisse@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-01-31 13:41:06 +0000
committerglisse <glisse@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-01-31 13:41:06 +0000
commitc68ef729971d88818ceae9f1aa8e33f62a4dea7a (patch)
tree2425f2d0f3d1e05799b0d5480d32449f8a3bd2ff /src/Rips_complex/doc
parent258439dfbe0d109b1ab26e9b60370cafdc78ac3e (diff)
Add example.
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/sparserips-glisse@3195 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: b8ded704563c6794c098f9b80b1a5e0200e84694
Diffstat (limited to 'src/Rips_complex/doc')
-rw-r--r--src/Rips_complex/doc/Intro_rips_complex.h16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/Rips_complex/doc/Intro_rips_complex.h b/src/Rips_complex/doc/Intro_rips_complex.h
index a9cfc0ab..96d90d98 100644
--- a/src/Rips_complex/doc/Intro_rips_complex.h
+++ b/src/Rips_complex/doc/Intro_rips_complex.h
@@ -182,6 +182,22 @@ namespace rips_complex {
*
* \include Rips_complex/full_skeleton_rips_for_doc.txt
*
+ * \subsection sparseripspointscloudexample Example of a sparse Rips from a point cloud
+ *
+ * This example builds the full sparse Rips of a set of 2D Euclidean points, then prints some minimal information about the complex.
+ *
+ * \include Rips_complex/example_sparse_rips.cpp
+ *
+ * When launching:
+ *
+ * \code $> ./Rips_complex_example_sparse
+ * \endcode
+ *
+ * the program output may be (the exact output varies from one run to the next):
+ *
+ * \code Sparse Rips complex is of dimension 2 - 19 simplices - 7 vertices.
+ * \endcode
+ *
* \copyright GNU General Public License v3.
* \verbatim Contact: gudhi-users@lists.gforge.inria.fr \endverbatim
*/