diff options
| author | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2020-07-31 16:21:55 +0200 |
|---|---|---|
| committer | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2020-07-31 16:21:55 +0200 |
| commit | d27d7839a3c32513ffc60eb709765c6a89e0e208 (patch) | |
| tree | bf89d2da7653e4ffc97548365bdcc540a9790487 /src/python/gudhi | |
| parent | 12c0266d7defec73a6e8da3990a7fc8d482cbde5 (diff) | |
Rebuild example page and link to example. Add also a link to the publication. Doc review: document edge collapse ignores simplices of higher dimension.
Diffstat (limited to 'src/python/gudhi')
| -rw-r--r-- | src/python/gudhi/simplex_tree.pyx | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/src/python/gudhi/simplex_tree.pyx b/src/python/gudhi/simplex_tree.pyx index 9eee5e14..62f81d0b 100644 --- a/src/python/gudhi/simplex_tree.pyx +++ b/src/python/gudhi/simplex_tree.pyx @@ -583,10 +583,12 @@ cdef class SimplexTree: return (normal0, normals, infinite0, infinites) def collapse_edges(self, nb_iterations = 1): - """Assuming the simplex tree is a 1-skeleton graph, this function collapse edges and resets the simplex tree - from the remaining edges. + """Assuming the simplex tree is a 1-skeleton graph, this method collapse edges (simplices of higher dimension + are ignored) and resets the simplex tree from the remaining edges. A good candidate is to build a simplex tree on top of a :class:`~gudhi.RipsComplex` of dimension 1 before - collapsing edges. + collapsing edges + (cf. :download:`rips_complex_edge_collapse_example.py <../example/rips_complex_edge_collapse_example.py>`). + For implementation details, please refer to :cite:`edgecollapsesocg2020`. :param nb_iterations: The number of edge collapse iterations to perform. Default is 1. :type nb_iterations: int |