diff options
| author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-09-11 20:08:29 +0000 |
|---|---|---|
| committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-09-11 20:08:29 +0000 |
| commit | de09c3d3a8c86b1538f66c674f6f9819abec16cc (patch) | |
| tree | ad60a2c31e7092941730ff9a95cf9e72d4954019 /src/Simplex_tree | |
| parent | f25099a09b2c0c4a6a317f2c869bc819462d7edf (diff) | |
Doc review: bad doc review fix
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/graph_expansion_with_blocker_oracle@2660 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: a024a1570e282c5ebd1c675d687372ee3dab0ed0
Diffstat (limited to 'src/Simplex_tree')
| -rw-r--r-- | src/Simplex_tree/include/gudhi/Simplex_tree.h | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/Simplex_tree/include/gudhi/Simplex_tree.h b/src/Simplex_tree/include/gudhi/Simplex_tree.h index 5cb13053..730b552f 100644 --- a/src/Simplex_tree/include/gudhi/Simplex_tree.h +++ b/src/Simplex_tree/include/gudhi/Simplex_tree.h @@ -1302,7 +1302,7 @@ class Simplex_tree { public: /** \brief Remove a maximal simplex. * @param[in] sh Simplex handle on the maximal simplex to remove. - * @return true if simplex was deleted, false otherwise. + * @return true if the leaf's branch has no other leaves (branch's children has been re-assigned), false otherwise. * \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). |