summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--src/Rips_complex/include/gudhi/Rips_complex.h11
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,