summaryrefslogtreecommitdiff
path: root/src/Simplex_tree/include/gudhi/Simplex_tree.h
diff options
context:
space:
mode:
authorMarc Glisse <marc.glisse@inria.fr>2020-03-06 18:10:05 +0100
committerMarc Glisse <marc.glisse@inria.fr>2020-03-06 18:10:05 +0100
commit5748647e9e89bb91e361b06c7c6cb053081618bf (patch)
tree6ca7b211a1cc2c9bd56a3ee11821c9a032358189 /src/Simplex_tree/include/gudhi/Simplex_tree.h
parent78ccc10eb0034a4648df303f2913b6b4680b085e (diff)
Fix doc of minimal_simplex_with_same_filtration
Diffstat (limited to 'src/Simplex_tree/include/gudhi/Simplex_tree.h')
-rw-r--r--src/Simplex_tree/include/gudhi/Simplex_tree.h8
1 files changed, 3 insertions, 5 deletions
diff --git a/src/Simplex_tree/include/gudhi/Simplex_tree.h b/src/Simplex_tree/include/gudhi/Simplex_tree.h
index 7315bf45..b6973756 100644
--- a/src/Simplex_tree/include/gudhi/Simplex_tree.h
+++ b/src/Simplex_tree/include/gudhi/Simplex_tree.h
@@ -1530,13 +1530,11 @@ class Simplex_tree {
return null_simplex();
}
- /** \brief Returns an edge of `sh` that has the same filtration value as `sh` if it exists, and `null_simplex()` otherwise.
+ /** \brief Returns a minimal face of `sh` that has the same filtration value as `sh`.
*
- * For a flag-complex built with `expansion()`, this is a way to invert the process and find out which edge had its filtration value propagated to `sh`.
- * If several edges have the same filtration value, the one it returns is arbitrary. */
+ * For a complex built with `make_filtration_non_decreasing()`, this is a way to invert the process and find out which simplex had its filtration value propagated to `sh`.
+ * If several minimal (for inclusion) simplices have the same filtration value, the one it returns is arbitrary, and it is not guaranteed to be the one with smallest dimension. */
Simplex_handle minimal_simplex_with_same_filtration(Simplex_handle sh) {
- if(dimension(sh) == 0) // vertices are minimal
- return sh;
auto filt = filtration_(sh);
// Naive implementation, it can be sped up.
for(auto b : boundary_simplex_range(sh))