From 90bb34c0e81b57ed85131ccaa638f457338c9219 Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Wed, 23 May 2018 08:22:35 +0000 Subject: Modify documentation for Simplex_tree make_filtration_non_decreasing git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/python_2.1.0_fix_vincent@3452 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 304779c7952985d651750aded78cb32c6e583555 --- src/Simplex_tree/include/gudhi/Simplex_tree.h | 5 ++--- 1 file changed, 2 insertions(+), 3 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 7456cb1f..d9e2d73e 100644 --- a/src/Simplex_tree/include/gudhi/Simplex_tree.h +++ b/src/Simplex_tree/include/gudhi/Simplex_tree.h @@ -1238,9 +1238,8 @@ class Simplex_tree { } public: - /** \brief Browse the simplex tree to ensure the filtration is not decreasing. - * The simplex tree is browsed starting from the root until the leaf, and the filtration values are set with their - * parent value (increased), in case the values are decreasing. + /** \brief This function ensures that each simplex has a higher filtration value than its faces by increasing the + * filtration values. * @return The filtration modification information. * \post Some simplex tree functions require the filtration to be valid. `make_filtration_non_decreasing()` * function is not launching `initialize_filtration()` but returns the filtration modification information. If the -- cgit v1.2.3