diff options
| author | Vincent Rouvreau <10407034+VincentRouvreau@users.noreply.github.com> | 2020-07-02 05:42:54 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-02 05:42:54 -0700 |
| commit | c82c2ddeaa51622a5c0e2b213f8611764fcf5b0a (patch) | |
| tree | bac688101767c353046b397649c98fdd8169cdd0 | |
| parent | 5131abd569ae5c4f11e753f1a6dc1ee232bcb96f (diff) | |
| parent | a3051bbe3a2f29a897d4acd9d58321c3775c68ef (diff) | |
Merge pull request #360 from VincentRouvreau/simplex_tree_generator_documentation
Fix SimplexTree generators documentation
| -rw-r--r-- | src/python/gudhi/simplex_tree.pyx | 5 |
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) |