diff options
author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2016-12-12 16:54:49 +0000 |
---|---|---|
committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2016-12-12 16:54:49 +0000 |
commit | 1569573662fe88c82ceb0846beb19701a95ac935 (patch) | |
tree | d36aff62fc6a37067d3700d88241d7a7d33e646b /src/Rips_complex | |
parent | 04e1b011959f93de8a7a252cdc9fa1f4aed0c12e (diff) |
Doc changed for review
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/distance_matrix_in_rips_module@1858 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 2b70b619233362adebdc3046c923090fac53a660
Diffstat (limited to 'src/Rips_complex')
-rw-r--r-- | src/Rips_complex/include/gudhi/Rips_complex.h | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/src/Rips_complex/include/gudhi/Rips_complex.h b/src/Rips_complex/include/gudhi/Rips_complex.h index f98a6993..3260e500 100644 --- a/src/Rips_complex/include/gudhi/Rips_complex.h +++ b/src/Rips_complex/include/gudhi/Rips_complex.h @@ -118,14 +118,13 @@ class Rips_complex { } private: - /** \brief Output the proximity graph of the points. + /** \brief Computes the proximity graph of the points. * - * If points contains n elements, the proximity graph is the graph - * with n vertices, and an edge [u,v] iff the distance function between - * points u and v is smaller than threshold. + * If points contains n elements, the proximity graph is the graph with n vertices, and an edge [u,v] iff the + * distance function between points u and v is smaller than threshold. * - * The type PointCloud furnishes .begin() and .end() methods, that return - * iterators with value_type Point. + * \tparam The type InputPointRange furnishes .begin() and .end() methods, that return iterators with + * value_type Point. */ template< typename InputPointRange, typename Distance > void compute_proximity_graph(const InputPointRange& points, Filtration_value threshold, |