diff options
author | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2020-07-01 10:34:54 +0200 |
---|---|---|
committer | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2020-07-01 10:34:54 +0200 |
commit | d8c5a1b263b5c008b7f41dc7f1cd18e185cd92ea (patch) | |
tree | 708b0fe5864f879196793a9e6051cc88c8ca8636 /src/Collapse | |
parent | 3bce2a71ab4a0fabb96fce56f32b605def0897a6 (diff) |
Doc review: Add some documentation for the free function
Diffstat (limited to 'src/Collapse')
-rw-r--r-- | src/Collapse/include/gudhi/Flag_complex_edge_collapser.h | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/src/Collapse/include/gudhi/Flag_complex_edge_collapser.h b/src/Collapse/include/gudhi/Flag_complex_edge_collapser.h index 60d75211..07575b3b 100644 --- a/src/Collapse/include/gudhi/Flag_complex_edge_collapser.h +++ b/src/Collapse/include/gudhi/Flag_complex_edge_collapser.h @@ -340,13 +340,20 @@ class Flag_complex_edge_collapser { }; -/** \brief Implicitly constructs a flag complex from edges as an input, collapses edges while preserving the persistent homology and returns the remaining edges as a range. +/** \brief Implicitly constructs a flag complex from edges as an input, collapses edges while preserving the persistent + * homology and returns the remaining edges as a range. * * \fn auto Gudhi::collapse::flag_complex_collapse_edges(FilteredEdgeRange const& edges) + * + * \param[in] edges Range of Filtered edges.There is no need the range to be sorted, as it will be performed. * * \tparam FilteredEdgeRange furnishes `std::begin` and `std::end` methods and returns an iterator on a - * FilteredEdge of type `std::tuple<Vertex_handle, Vertex_handle, Filtration_value>` where Vertex_handle is the index of a vertex. + * FilteredEdge of type `std::tuple<Vertex_handle, Vertex_handle, Filtration_value>` where `Vertex_handle` is the type + * of a vertex index and `Filtration_value` is the type of an edge filtration value. * + * \return Remaining edges after collapse of type + * `std::vector<std::tuple<Vertex_handle, Vertex_handle, Filtration_value>>`. + * * \ingroup edge_collapse * */ |