diff options
| author | Marc Glisse <marc.glisse@inria.fr> | 2022-11-16 09:55:36 +0100 |
|---|---|---|
| committer | Marc Glisse <marc.glisse@inria.fr> | 2022-11-16 09:55:36 +0100 |
| commit | 1f532933658bf6788b1ead8ae1d902416872e70a (patch) | |
| tree | 8409940e26de6e9332c1fdc466e73ced9da800b7 | |
| parent | 75d308755df7ebe0d0b7c6183f4c33512ae58b24 (diff) | |
Clarify doc.
| -rw-r--r-- | src/python/gudhi/simplex_tree.pyx | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/src/python/gudhi/simplex_tree.pyx b/src/python/gudhi/simplex_tree.pyx index 372cb15c..24b970c4 100644 --- a/src/python/gudhi/simplex_tree.pyx +++ b/src/python/gudhi/simplex_tree.pyx @@ -290,6 +290,8 @@ cdef class SimplexTree: def insert_batch(self, some_int[:,:] vertex_array, some_float[:] filtrations): """Inserts k-simplices given by a sparse array in a format similar to `torch.sparse <https://pytorch.org/docs/stable/sparse.html>`_. + The n-th simplex has vertices `vertex_array[0,n]`, ..., + `vertex_array[k,n]` and filtration value `filtrations[n]`. If a simplex is repeated, the smallest filtration value is used. Simplices with a repeated vertex are currently interpreted as lower dimensional simplices, but we do not guarantee this behavior in the |