summaryrefslogtreecommitdiff
path: root/src/Simplex_tree/include/gudhi
diff options
context:
space:
mode:
authorVincent Rouvreau <VincentRouvreau@users.noreply.github.com>2019-06-06 11:16:38 +0200
committerGitHub <noreply@github.com>2019-06-06 11:16:38 +0200
commitb858862d63ffcdcaed0e0a4913f5d9d42bc0dcbb (patch)
tree9f09a820a819fe2886d7050c71cf41a4aa35a3d5 /src/Simplex_tree/include/gudhi
parentb9ddc3b6f1501fc15e84a8bea5927adae6623e5a (diff)
parentef5fcf9e54e0c14f7c2e7eebb5c24fb91018606a (diff)
Merge pull request #66 from VincentRouvreau/small_fixes
Small fixes
Diffstat (limited to 'src/Simplex_tree/include/gudhi')
-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.