Document SimplexTree __eq__, __getstate__ and __setstate__

DerbelHedi · Apr 17, 2023 · bdfe6a1 · bdfe6a1
1 parent 0b4ae5f
commit bdfe6a1
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/src/python/doc/simplex_tree_ref.rst b/src/python/doc/simplex_tree_ref.rst
@@ -8,4 +8,5 @@ Simplex tree reference manual
 
 .. autoclass:: gudhi.SimplexTree
    :members:
+   :special-members: __eq__, __getstate__, __setstate__
    :show-inheritance:
diff --git a/src/python/gudhi/simplex_tree.pyx b/src/python/gudhi/simplex_tree.pyx
@@ -812,16 +812,19 @@ cdef class SimplexTree:
 
     def __eq__(self, other:SimplexTree):
         """Test for structural equality
+
         :returns: True if the 2 simplex trees are equal, False otherwise.
         :rtype: bool
         """
         return dereference(self.get_ptr()) == dereference(other.get_ptr())
 
     def __getstate__(self):
         """Pickle the SimplexTree data structure as a Python Byte Array
-        :raises MemoryError: In the case the serialization allocates a too large block of memory.
+
         :returns: Serialized SimplexTree data structure
         :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
@@ -835,6 +838,7 @@ cdef class SimplexTree:
 
     def __setstate__(self, state):
         """Construct the SimplexTree data structure from a Python Byte Array
+        
         :param state: Serialized SimplexTree data structure
         :type state: numpy.array of shape (n,)
         """