summaryrefslogtreecommitdiff
path: root/src/python/gudhi/simplex_tree.pyx
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-07-02 21:11:18 +0200
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-07-02 21:11:18 +0200
commit0f364d372a6bce81d895d4ccd066174bad260e9e (patch)
treec9067237d5790125fbcbb8fd784064f2b413a5ee /src/python/gudhi/simplex_tree.pyx
parenteedb34f25d76cb3dc7ccb6b59a60217a26eedfcd (diff)
parent3c7a4d01ec758d68a219fae8981c9847cf8d7a0f (diff)
Merge branch 'master' into edge_collapse_integration_vincent
Diffstat (limited to 'src/python/gudhi/simplex_tree.pyx')
-rw-r--r--src/python/gudhi/simplex_tree.pyx5
1 files changed, 2 insertions, 3 deletions
diff --git a/src/python/gudhi/simplex_tree.pyx b/src/python/gudhi/simplex_tree.pyx
index 9cb24221..20e66d9f 100644
--- a/src/python/gudhi/simplex_tree.pyx
+++ b/src/python/gudhi/simplex_tree.pyx
@@ -225,13 +225,12 @@ cdef class SimplexTree:
preincrement(it)
def get_skeleton(self, dimension):
- """This function returns the (simplices of the) skeleton of a maximum
- given dimension.
+ """This function returns a generator with the (simplices of the) skeleton of a maximum given dimension.
:param dimension: The skeleton dimension value.
:type dimension: int.
:returns: The (simplices of the) skeleton of a maximum dimension.
- :rtype: list of tuples(simplex, filtration)
+ :rtype: generator with tuples(simplex, filtration)
"""
cdef Simplex_tree_skeleton_iterator it = self.get_ptr().get_skeleton_iterator_begin(dimension)
cdef Simplex_tree_skeleton_iterator end = self.get_ptr().get_skeleton_iterator_end(dimension)