diff options
| author | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2020-07-01 07:41:13 +0200 |
|---|---|---|
| committer | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2020-07-01 07:41:13 +0200 |
| commit | 7fb8f17638ee7245a1eb6c604c6629a484612179 (patch) | |
| tree | 32f7cc15d2345941234944a9cd4abf83cf240774 /src | |
| parent | 7ed01ff1d89256038e0cfb0e2d86815437e55545 (diff) | |
Doc review: add some details about get_point
Diffstat (limited to 'src')
| -rw-r--r-- | src/python/doc/alpha_complex_user.rst | 2 | ||||
| -rw-r--r-- | src/python/gudhi/alpha_complex.pyx | 2 |
2 files changed, 3 insertions, 1 deletions
diff --git a/src/python/doc/alpha_complex_user.rst b/src/python/doc/alpha_complex_user.rst index 714c5343..fd4a2372 100644 --- a/src/python/doc/alpha_complex_user.rst +++ b/src/python/doc/alpha_complex_user.rst @@ -34,6 +34,8 @@ Remarks the computation of filtration values can exceptionally be arbitrarily bad. In all cases, we still guarantee that the output is a valid filtration (faces have a filtration value no larger than their cofaces). * For performances reasons, it is advised to use Alpha_complex with `CGAL <installation.html#cgal>`_ :math:`\geq` 5.0.0. +* The vertices in the output simplex tree are not guaranteed to match the order of the input points. One can use + :func:`~gudhi.AlphaComplex.get_point` to get the initial point back. Example from points ------------------- diff --git a/src/python/gudhi/alpha_complex.pyx b/src/python/gudhi/alpha_complex.pyx index ac44c61f..ea128743 100644 --- a/src/python/gudhi/alpha_complex.pyx +++ b/src/python/gudhi/alpha_complex.pyx @@ -99,7 +99,7 @@ cdef class AlphaComplex: return self.this_ptr != NULL def get_point(self, vertex): - """This function returns the point corresponding to a given vertex. + """This function returns the point corresponding to a given vertex from the :class:`~gudhi.SimplexTree`. :param vertex: The vertex. :type vertex: int |