summaryrefslogtreecommitdiff
path: root/src/Simplex_tree
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-05-23 08:22:35 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-05-23 08:22:35 +0000
commit90bb34c0e81b57ed85131ccaa638f457338c9219 (patch)
treee9cfb890f54d705984ce70721e06f76c662a2e76 /src/Simplex_tree
parent71840751fcd4771d126c0ebe2f63a02c14e67186 (diff)
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
Diffstat (limited to 'src/Simplex_tree')
-rw-r--r--src/Simplex_tree/include/gudhi/Simplex_tree.h5
1 files changed, 2 insertions, 3 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