diff options
| author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-10-20 08:10:05 +0000 |
|---|---|---|
| committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-10-20 08:10:05 +0000 |
| commit | e36dafedbab909ef1d16eceb133cd8b80dd1763d (patch) | |
| tree | 9e7c61a9e8f2d231ea004c72cbcb256175364a8b /src | |
| parent | 4e3cf64d56874353aea48ccc1820069bbf37671a (diff) | |
Doc review: remove_maximal_simplex about automatic_dimension_set mechanism was too strict.
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/ST_automatic_dimension_set@2795 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 0226b3ee6a082b109185c9eff8c1601b61d4f667
Diffstat (limited to 'src')
| -rw-r--r-- | src/Simplex_tree/include/gudhi/Simplex_tree.h | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/src/Simplex_tree/include/gudhi/Simplex_tree.h b/src/Simplex_tree/include/gudhi/Simplex_tree.h index a2febe54..7841c793 100644 --- a/src/Simplex_tree/include/gudhi/Simplex_tree.h +++ b/src/Simplex_tree/include/gudhi/Simplex_tree.h @@ -1228,7 +1228,9 @@ class Simplex_tree { * \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). - * \post Be aware that removing may change the simplex tree dimension (`automatic_dimension_set()` to be done). + * \post Note that the dimension of the simplicial complex may be lower after calling `remove_maximal_simplex()` + * than it was before. However, `Simplex_tree::dimension()` will return the old value, which remains a valid upper + * bound. If you care, you can call `automatic_dimension_set()` to recompute the exact dimension. */ void remove_maximal_simplex(Simplex_handle sh) { // Guarantee the simplex has no children |