diff options
| author | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2020-07-01 22:09:58 +0200 |
|---|---|---|
| committer | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2020-07-01 22:09:58 +0200 |
| commit | f7876ea08e810c57f90e0233fffbd91d57f6d037 (patch) | |
| tree | 2eeb9d450e19555b0ee1440dd245b88c313f5431 /src | |
| parent | cf5deb9997ee0da5253d40cc2d2382fa2ca758ec (diff) | |
doc review: fix some errors
Diffstat (limited to 'src')
| -rw-r--r-- | src/Collapse/include/gudhi/Flag_complex_edge_collapser.h | 6 | ||||
| -rw-r--r-- | src/common/doc/main_page.md | 2 |
2 files changed, 3 insertions, 5 deletions
diff --git a/src/Collapse/include/gudhi/Flag_complex_edge_collapser.h b/src/Collapse/include/gudhi/Flag_complex_edge_collapser.h index 01be8f03..d1a47b75 100644 --- a/src/Collapse/include/gudhi/Flag_complex_edge_collapser.h +++ b/src/Collapse/include/gudhi/Flag_complex_edge_collapser.h @@ -342,16 +342,14 @@ 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. * - * \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 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>>`. + * \return Remaining edges after collapse as a range of + * `<std::tuple<Vertex_handle, Vertex_handle, Filtration_value>`. * * \ingroup edge_collapse * diff --git a/src/common/doc/main_page.md b/src/common/doc/main_page.md index 740a3e52..e19af537 100644 --- a/src/common/doc/main_page.md +++ b/src/common/doc/main_page.md @@ -235,7 +235,7 @@ </td> <td width="15%"> <b>Author:</b> Siddharth Pritam<br> - <b>Introduced in:</b> GUDHI 2.4.0<br> + <b>Introduced in:</b> GUDHI 3.3.0<br> <b>Copyright:</b> MIT<br> <b>Requires:</b> \ref eigen </td> |