diff options
| author | Vincent Rouvreau <vincent.rouvreau@inria.fr> | 2022-03-28 09:00:23 +0200 |
|---|---|---|
| committer | Vincent Rouvreau <vincent.rouvreau@inria.fr> | 2022-03-28 09:00:23 +0200 |
| commit | f6a45247e9a9f126c214d1b1003ae19fb2cc84a3 (patch) | |
| tree | 0c4bd79ad75fbb0b8d2f45043de00e92a3d50d81 /src/python/gudhi/simplex_tree.pyx | |
| parent | 924302f092d6d08c59500c5f6e75bcad9416581a (diff) | |
doc review: add a warning about phantom simplices for blocker_func
Diffstat (limited to 'src/python/gudhi/simplex_tree.pyx')
| -rw-r--r-- | src/python/gudhi/simplex_tree.pyx | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/python/gudhi/simplex_tree.pyx b/src/python/gudhi/simplex_tree.pyx index fc704358..a4914184 100644 --- a/src/python/gudhi/simplex_tree.pyx +++ b/src/python/gudhi/simplex_tree.pyx @@ -487,6 +487,11 @@ cdef class SimplexTree: with this new simplex (represented as a list of int). If `blocker_func` returns `True`, the simplex is removed, otherwise it is kept. The algorithm then proceeds with the next candidate. + .. warning:: + Several candidates of the same dimension may be inserted simultaneously before calling `block_simplex`, so + if you examine the complex in `block_simplex`, you may hit a few simplices of the same dimension that have + not been vetted by `block_simplex` yet, or have already been rejected but not yet removed. + :param max_dim: Expansion maximal dimension value. :type max_dim: int :param blocker_func: Blocker oracle. |