From 6fff7c1774365f99c93d57bdf3595e6b89f16b0a Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Fri, 20 Oct 2017 08:24:03 +0000 Subject: Code review : rename automatic_dimension_set with downgrade_dimension git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/ST_automatic_dimension_set@2796 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 3b094bc579367d40790c3791f2c4a3700a3d93ae --- src/Simplex_tree/include/gudhi/Simplex_tree.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'src/Simplex_tree/include') diff --git a/src/Simplex_tree/include/gudhi/Simplex_tree.h b/src/Simplex_tree/include/gudhi/Simplex_tree.h index 7841c793..986cc071 100644 --- a/src/Simplex_tree/include/gudhi/Simplex_tree.h +++ b/src/Simplex_tree/include/gudhi/Simplex_tree.h @@ -1163,7 +1163,7 @@ class Simplex_tree { * complex has changed , please call `initialize_filtration()` to recompute it. * \post Note that the dimension of the simplicial complex may be lower after calling `prune_above_filtration()` * 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. + * bound. If you care, you can call `downgrade_dimension()` to recompute the exact dimension. */ bool prune_above_filtration(Filtration_value filtration) { return rec_prune_above_filtration(root(), filtration); @@ -1195,12 +1195,12 @@ class Simplex_tree { } public: - /** \brief Deep search simplex tree dimension reset. + /** \brief Deep search simplex tree dimension recompute. * @return True if the dimension was modified, false otherwise. * \pre Be sure the simplex tree has not a too low dimension value as the deep search stops when the former dimension * has been reached (cf. `dimension()` and `set_dimension()` methods). */ - bool automatic_dimension_set() { + bool downgrade_dimension() { int new_dimension = -1; // Browse the tree from the left to the right as higher dimension cells are more likely on the left part of the tree for (Simplex_handle sh : skeleton_simplex_range(dimension_)) { @@ -1230,7 +1230,7 @@ class Simplex_tree { * \post Be aware that removing is shifting data in a flat_map (`initialize_filtration()` 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. + * bound. If you care, you can call `downgrade_dimension()` to recompute the exact dimension. */ void remove_maximal_simplex(Simplex_handle sh) { // Guarantee the simplex has no children -- cgit v1.2.3