diff options
author | Marc Glisse <marc.glisse@inria.fr> | 2019-11-19 17:41:39 +0100 |
---|---|---|
committer | Marc Glisse <marc.glisse@inria.fr> | 2019-11-19 17:41:39 +0100 |
commit | 4d44e27f65488964a3c8af7038d3d9b90e6d5a43 (patch) | |
tree | b64fa82e100957722009ce830184b2a39e241ee1 /src/python/gudhi | |
parent | 9471d51c322ccbff12482c9c9cf2df98b9bdb50c (diff) |
Add warning in the doc of assign_filtration
Apparently some users expect that it will magically "fix" other
simplices so it remains a valid filtration.
Diffstat (limited to 'src/python/gudhi')
-rw-r--r-- | src/python/gudhi/simplex_tree.pyx | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/src/python/gudhi/simplex_tree.pyx b/src/python/gudhi/simplex_tree.pyx index ade3bf6c..4a3cd9bc 100644 --- a/src/python/gudhi/simplex_tree.pyx +++ b/src/python/gudhi/simplex_tree.pyx @@ -74,13 +74,22 @@ cdef class SimplexTree: return self.get_ptr().simplex_filtration(simplex) def assign_filtration(self, simplex, filtration): - """This function assigns the simplicial complex filtration value for a + """This function assigns a new filtration value to a given N-simplex. :param simplex: The N-simplex, represented by a list of vertex. :type simplex: list of int. - :param filtration: The simplicial complex filtration value. + :param filtration: The new filtration value. :type filtration: float + + .. note:: + Beware that after this operation, the structure may not be a valid + filtration anymore, a simplex could have a lower filtration value + than one of its faces. Callers are responsible for fixing this + (with more :meth:`assign_filtration` or + :meth:`make_filtration_non_decreasing` for instance) before calling + any function that relies on the filtration property, like + :meth:`initialize_filtration`. """ self.get_ptr().assign_simplex_filtration(simplex, filtration) |