diff options
| author | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2020-04-28 08:33:51 +0200 |
|---|---|---|
| committer | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2020-04-28 08:33:51 +0200 |
| commit | 4fdc721bbd19bc6389d611d252ff08f8fbbeee23 (patch) | |
| tree | c0f57417b3bbc5d38f54189de7d0405ef1afee17 /src/common | |
| parent | 1508cef62980fb59ac7e1b0b30f560083ec3988a (diff) | |
Code and doc review fix
Diffstat (limited to 'src/common')
| -rw-r--r-- | src/common/doc/main_page.md | 2 | ||||
| -rw-r--r-- | src/common/include/gudhi/graph_simplicial_complex.h | 8 |
2 files changed, 9 insertions, 1 deletions
diff --git a/src/common/doc/main_page.md b/src/common/doc/main_page.md index cdea3d94..85b39be9 100644 --- a/src/common/doc/main_page.md +++ b/src/common/doc/main_page.md @@ -242,7 +242,7 @@ </tr> </table> -#### Strong collapse +#### Edge collapse <table> <tr> 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 <tuple> // for std::tie namespace Gudhi { +/** @file + * @brief Graph simplicial complex methods + */ /* Edge tag for Boost PropertyGraph. */ struct edge_filtration_t { @@ -43,9 +46,14 @@ using Proximity_graph = typename boost::adjacency_list < boost::vecS, boost::vec /** \brief Computes the proximity graph of the points. * + * \fn Gudhi::Proximity_graph<SimplicialComplexForProximityGraph> 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 |