diff options
author | Marc Glisse <marc.glisse@inria.fr> | 2020-07-08 21:31:10 +0200 |
---|---|---|
committer | Marc Glisse <marc.glisse@inria.fr> | 2020-07-08 21:31:10 +0200 |
commit | 598a6bb607edd079c3c6c49dc631f987621b12cb (patch) | |
tree | ecf787a91321fa9835fa82b67d7f11904415d77a /src | |
parent | 49ded65ab14175656a15c904645cc4e6476927ba (diff) |
Minor doc tweak
Diffstat (limited to 'src')
-rw-r--r-- | src/python/gudhi/simplex_tree.pyx | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/python/gudhi/simplex_tree.pyx b/src/python/gudhi/simplex_tree.pyx index 5e032e2f..557a80a9 100644 --- a/src/python/gudhi/simplex_tree.pyx +++ b/src/python/gudhi/simplex_tree.pyx @@ -196,7 +196,7 @@ cdef class SimplexTree: return self.get_ptr().insert(simplex, <double>filtration) def insert_array(self, filtrations, double max_filtration=numpy.inf): - """Inserts edges in an empty complex. The vertices are numbered from 0 to n, and the filtration values are + """Inserts edges in an empty complex. The vertices are numbered from 0 to n-1, and the filtration values are encoded in the array, with the diagonal representing the vertices. It is the caller's responsibility to ensure that this defines a filtration, which can be achieved with either:: @@ -208,7 +208,7 @@ cdef class SimplexTree: filtrations = np.fmax(np.fmax(filtrations, diag[:, None]), diag[None, :]) :param filtrations: the filtration values of the vertices and edges to insert. The matrix is assumed to be symmetric. - :type filtrations: numpy.ndarray of shape (n,n) + :type filtrations: symmetric numpy.ndarray of shape (n,n) :param max_filtration: only insert vertices and edges with filtration values no larger than max_filtration :type max_filtration: float """ |