Skip to content

Commit

Permalink
doc review: add a warning about phantom simplices for blocker_func
Browse files Browse the repository at this point in the history
  • Loading branch information
VincentRouvreau committed Mar 28, 2022
1 parent 924302f commit f6a4524
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/python/gudhi/simplex_tree.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit f6a4524

Please sign in to comment.