diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/Simplex_tree/include/gudhi/Simplex_tree.h | 5 | ||||
| -rw-r--r-- | src/cython/cython/simplex_tree.pyx | 6 |
2 files changed, 4 insertions, 7 deletions
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 diff --git a/src/cython/cython/simplex_tree.pyx b/src/cython/cython/simplex_tree.pyx index 38740f4f..667fd40b 100644 --- a/src/cython/cython/simplex_tree.pyx +++ b/src/cython/cython/simplex_tree.pyx @@ -402,10 +402,8 @@ cdef class SimplexTree: self.thisptr.expansion(max_dim) def make_filtration_non_decreasing(self): - """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. + """This function ensures that each simplex has a higher filtration + value than its faces by increasing the filtration values. :returns: The filtration modification information. :rtype: bint |