From 9c2047f19dbeac21e3a24228501d819316b0993a Mon Sep 17 00:00:00 2001 From: hschreiber Date: Tue, 29 Oct 2024 15:03:15 +0100 Subject: [PATCH] doc --- src/Simplex_tree/include/gudhi/Simplex_tree.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/Simplex_tree/include/gudhi/Simplex_tree.h b/src/Simplex_tree/include/gudhi/Simplex_tree.h index ce8d655bf..53225db16 100644 --- a/src/Simplex_tree/include/gudhi/Simplex_tree.h +++ b/src/Simplex_tree/include/gudhi/Simplex_tree.h @@ -1245,7 +1245,10 @@ class Simplex_tree { * wanted filtration. Takes two Simplex_handle as input and returns true if and only if the first simplex appears * strictly before the second simplex in the resulting 1-parameter filtration. * @param ignore_simplex Method taking a simplex handle as input and returns true if and only if the corresponding - * simplex should be ignored in the filtration and therefore not be cached. + * simplex should be ignored in the filtration and therefore not be cached. But note that it is important that + * the resulting filtration is still a valid filtration, that is all proper faces of a not ignored simplex + * should also not be ignored and have to appear before this simplex. There will be no tests to ensure that, so + * it is of the users responsibility. */ template void initialize_filtration(Comparator&& is_before_in_filtration, Ignorer&& ignore_simplex) {