From 4fdc721bbd19bc6389d611d252ff08f8fbbeee23 Mon Sep 17 00:00:00 2001 From: ROUVREAU Vincent Date: Tue, 28 Apr 2020 08:33:51 +0200 Subject: Code and doc review fix --- src/common/include/gudhi/graph_simplicial_complex.h | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'src/common/include/gudhi/graph_simplicial_complex.h') diff --git a/src/common/include/gudhi/graph_simplicial_complex.h b/src/common/include/gudhi/graph_simplicial_complex.h index b8508697..3e7720d7 100644 --- a/src/common/include/gudhi/graph_simplicial_complex.h +++ b/src/common/include/gudhi/graph_simplicial_complex.h @@ -19,6 +19,9 @@ #include // for std::tie namespace Gudhi { +/** @file + * @brief Graph simplicial complex methods + */ /* Edge tag for Boost PropertyGraph. */ struct edge_filtration_t { @@ -42,10 +45,15 @@ using Proximity_graph = typename boost::adjacency_list < boost::vecS, boost::vec , boost::property < edge_filtration_t, typename SimplicialComplexForProximityGraph::Filtration_value >>; /** \brief Computes the proximity graph of the points. + * + * \fn Gudhi::Proximity_graph compute_proximity_graph(const ForwardPointRange& + * points, typename SimplicialComplexForProximityGraph::Filtration_value threshold, Distance distance) * * 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. * + * \tparam SimplicialComplexForProximityGraph furnishes `Filtration_value` and `Vertex_handle` type definitions. + * * \tparam ForwardPointRange furnishes `.begin()` and `.end()` methods. * * \tparam Distance furnishes `operator()(const Point& p1, const Point& p2)`, where -- cgit v1.2.3