diff options
| author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-09-26 19:57:06 +0000 |
|---|---|---|
| committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-09-26 19:57:06 +0000 |
| commit | 697884f4193c32723922aa5edfef37d09d198fac (patch) | |
| tree | 94e9f886d4016e9c01466f16c5822abdab03a9b3 /src/Simplex_tree/include | |
| parent | c2ee3f09c901eb3cefa8635ae69564be99d73e90 (diff) | |
Doc review : Simplex tree remove maximal simplex is an implementatino detail that is not needed by the developper
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/graph_expansion_with_blocker_oracle@2717 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: d096485bf30e50c804cf349f040f57764770136f
Diffstat (limited to 'src/Simplex_tree/include')
| -rw-r--r-- | src/Simplex_tree/include/gudhi/Simplex_tree.h | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/src/Simplex_tree/include/gudhi/Simplex_tree.h b/src/Simplex_tree/include/gudhi/Simplex_tree.h index 730b552f..fe1e87b4 100644 --- a/src/Simplex_tree/include/gudhi/Simplex_tree.h +++ b/src/Simplex_tree/include/gudhi/Simplex_tree.h @@ -1302,10 +1302,11 @@ class Simplex_tree { public: /** \brief Remove a maximal simplex. * @param[in] sh Simplex handle on the maximal simplex to remove. - * @return true if the leaf's branch has no other leaves (branch's children has been re-assigned), false otherwise. + * @return a boolean value that is an implementation detail, and that the user is supposed to ignore * \pre Please check the simplex has no coface before removing it. * \exception std::invalid_argument In debug mode, if sh has children. * \post Be aware that removing is shifting data in a flat_map (initialize_filtration to be done). + * \internal @return true if the leaf's branch has no other leaves (branch's children has been re-assigned), false otherwise. */ bool remove_maximal_simplex(Simplex_handle sh) { // Guarantee the simplex has no children |