summaryrefslogtreecommitdiff
path: root/src/Simplex_tree/include/gudhi/Simplex_tree.h
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2019-06-07 15:34:25 +0200
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2019-06-07 15:34:25 +0200
commit3807bd77af3d03beace12305ef866cb6172e1f82 (patch)
tree2438ea24407111fc011a810ef67b5e31e8974614 /src/Simplex_tree/include/gudhi/Simplex_tree.h
parenta08323ea6b3706191bbd546fcbfcd5d321e0ac92 (diff)
parentb858862d63ffcdcaed0e0a4913f5d9d42bc0dcbb (diff)
Merge branch 'master' of github.com:GUDHI/gudhi-devel
Diffstat (limited to 'src/Simplex_tree/include/gudhi/Simplex_tree.h')
-rw-r--r--src/Simplex_tree/include/gudhi/Simplex_tree.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/Simplex_tree/include/gudhi/Simplex_tree.h b/src/Simplex_tree/include/gudhi/Simplex_tree.h
index 4b18651c..343ed472 100644
--- a/src/Simplex_tree/include/gudhi/Simplex_tree.h
+++ b/src/Simplex_tree/include/gudhi/Simplex_tree.h
@@ -1330,7 +1330,7 @@ class Simplex_tree {
public:
/** \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.
+ * @return True if any filtration value was modified, false if the filtration was already non-decreasing.
* \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
* complex has changed , please call `initialize_filtration()` to recompute it.