diff options
| author | Vincent Rouvreau <vincent.rouvreau@inria.fr> | 2022-02-28 10:56:47 +0100 |
|---|---|---|
| committer | Vincent Rouvreau <vincent.rouvreau@inria.fr> | 2022-02-28 10:56:47 +0100 |
| commit | e7ba8967e9b5c3c7260522003d8f87e643b7912e (patch) | |
| tree | 7309a81e6f35430b1925de3736dab782bc2f8775 /src/python/gudhi/simplex_tree.pyx | |
| parent | 4e63e52758daa7ef27782b4f129b7e55fa73de43 (diff) | |
doc review: reformulate the copy notes
Diffstat (limited to 'src/python/gudhi/simplex_tree.pyx')
| -rw-r--r-- | src/python/gudhi/simplex_tree.pyx | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/src/python/gudhi/simplex_tree.pyx b/src/python/gudhi/simplex_tree.pyx index 711796d4..91e079aa 100644 --- a/src/python/gudhi/simplex_tree.pyx +++ b/src/python/gudhi/simplex_tree.pyx @@ -48,8 +48,8 @@ cdef class SimplexTree: :rtype: SimplexTree :raises TypeError: In case `other` is neither `None`, nor a `SimplexTree`. - :note: If the `SimplexTree` is a copy, it requires :func:`compute_persistence` to be launched again as the - persistence result is not copied. + :note: If the `SimplexTree` is a copy, the persistence information is not copied. If you need it in the clone, + you have to call :func:`compute_persistence` on it even if you had already computed it in the original. """ # The real cython constructor @@ -86,7 +86,8 @@ cdef class SimplexTree: :returns: A simplex tree that is a deep copy of itself. :rtype: SimplexTree - :note: copy requires :func:`compute_persistence` to be launched again as the persistence result is not copied. + :note: The persistence information is not copied. If you need it in the clone, you have to call + :func:`compute_persistence` on it even if you had already computed it in the original. """ stree = SimplexTree() cdef Simplex_tree_interface_full_featured* stree_ptr |