diff options
author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2016-11-21 16:24:15 +0000 |
---|---|---|
committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2016-11-21 16:24:15 +0000 |
commit | 1a728400187d89db914e865a979c85c7260b0b02 (patch) | |
tree | ced1be64955f9a5a75f97334923948d147acb54d /src/Rips_complex/doc | |
parent | d03c111cbb3329018d72c7ed8bea2d7ac9a57045 (diff) |
Add distance matrix rips construction (doc, code, test)
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/distance_matrix_in_rips_module@1766 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 6b9bdecbaf0aca12facb023e66bdea71e8e8cd38
Diffstat (limited to 'src/Rips_complex/doc')
-rw-r--r-- | src/Rips_complex/doc/Intro_rips_complex.h | 52 |
1 files changed, 48 insertions, 4 deletions
diff --git a/src/Rips_complex/doc/Intro_rips_complex.h b/src/Rips_complex/doc/Intro_rips_complex.h index a71946b5..d01b14bb 100644 --- a/src/Rips_complex/doc/Intro_rips_complex.h +++ b/src/Rips_complex/doc/Intro_rips_complex.h @@ -2,7 +2,7 @@ * (Geometric Understanding in Higher Dimensions) is a generic C++ * library for computational topology. * - * Author(s): Clément Maria, Vincent Rouvreau + * Author(s): Clément Maria, Pawel Dlotko, Vincent Rouvreau * * Copyright (C) 2016 INRIA * @@ -29,7 +29,7 @@ namespace rips_complex { /** \defgroup rips_complex Rips complex * - * \author Clément Maria, Vincent Rouvreau + * \author Clément Maria, Pawel Dlotko, Vincent Rouvreau * * @{ * @@ -54,7 +54,9 @@ 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). * - * \section ripspointsexample Example from points + * \section ripspointsdistance Point cloud and distance function + * + * \subsection ripspointscloudexample Example from a point cloud and a distance function * * This example builds the one skeleton graph from the given points, threshold value, and distance function. * Then it creates a `Simplex_tree` with it. @@ -73,7 +75,7 @@ namespace rips_complex { * * \include Rips_complex/one_skeleton_rips_points_for_doc.txt * - * \section ripsoffexample Example from OFF file + * \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 * function. @@ -93,6 +95,48 @@ namespace rips_complex { * * \include Rips_complex/full_skeleton_rips_points_for_doc.txt * + * + * + * \section ripsdistancematrix Distance matrix + * + * \subsection ripsdistancematrixexample Example from a distance matrix + * + * This example builds the one skeleton graph from the given distance matrix and threshold value. + * Then it creates a `Simplex_tree` with it. + * + * Then, it is asked to display information about the simplicial complex. + * + * \include Rips_complex/example_one_skeleton_rips_from_distance_matrix.cpp + * + * When launching (rips maximal distance between 2 points is 1.0, is expanded until dimension 1 - one skeleton graph + * with other words): + * + * \code $> ./oneskeletonripsdistance 1.0 + * \endcode + * + * the program output is: + * + * \include Rips_complex/one_skeleton_rips_distance_for_doc.txt + * + * \subsection ripscsvdistanceexample Example from a distance matrix read in a csv file + * + * This example builds the one skeleton graph from the given distance matrix read in a csv file and threshold value. + * Then it creates a `Simplex_tree` with it. + * + * + * Then, it is asked to display information about the rips complex. + * + * \include Rips_complex/example_rips_complex_from_csv_distance_matrix_file.cpp + * + * When launching: + * + * \code $> ./ripscsvdistancereader ../../data/distance_matrix/full_square_distance_matrix.csv 1.0 3 + * \endcode + * + * the program output is: + * + * \include Rips_complex/full_skeleton_rips_distance_for_doc.txt + * * \copyright GNU General Public License v3. * \verbatim Contact: gudhi-users@lists.gforge.inria.fr \endverbatim */ |