Skip to content

Commit

Permalink
doc review: remove exception documentation and review __getstate__ do…
Browse files Browse the repository at this point in the history
…cumentation
  • Loading branch information
VincentRouvreau committed Apr 19, 2023
1 parent a2ac2e5 commit a3e9c0d
Showing 1 changed file with 1 addition and 5 deletions.
6 changes: 1 addition & 5 deletions src/python/gudhi/simplex_tree.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -817,12 +817,8 @@ cdef class SimplexTree:
return dereference(self.get_ptr()) == dereference(other.get_ptr())

def __getstate__(self):
"""Pickle the SimplexTree data structure as a Python Byte Array
:returns: Serialized SimplexTree data structure
""":returns: Serialized (or flattened) SimplexTree data structure for the SimplexTree to be pickled.
:rtype: numpy.array of shape (n,)
:raises MemoryError: In the case the serialization allocates a too large block of memory.
"""
cdef size_t buffer_size = self.get_ptr().get_serialization_size()
# Let's use numpy to allocate a buffer. Will be deleted automatically
Expand Down

0 comments on commit a3e9c0d

Please sign in to comment.