diff options
| author | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2021-06-09 11:47:34 +0200 |
|---|---|---|
| committer | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2021-06-09 11:47:34 +0200 |
| commit | f1effb5b5bf30275a692b51528ec068f7cef84ab (patch) | |
| tree | cfdc0cde75cb233d08d24629b80539a662faf2c4 /src/python/doc/alpha_complex_user.rst | |
| parent | afd0a890b39e40cd3ce358c647ae5e77eb288e07 (diff) | |
doc review: use 120 characters per line and warning about the numbering of vertices for 3d version
Diffstat (limited to 'src/python/doc/alpha_complex_user.rst')
| -rw-r--r-- | src/python/doc/alpha_complex_user.rst | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/src/python/doc/alpha_complex_user.rst b/src/python/doc/alpha_complex_user.rst index 985ee962..e615d0be 100644 --- a/src/python/doc/alpha_complex_user.rst +++ b/src/python/doc/alpha_complex_user.rst @@ -34,8 +34,6 @@ 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 ------------------- @@ -264,4 +262,10 @@ Then, it computes the persistence diagram and displays it: :Requires: `Eigen <installation.html#eigen>`_ :math:`\geq` 3.1.0 and `CGAL <installation.html#cgal>`_ :math:`\geq` 4.11.0. A specific module for Alpha complex is available in 3d (cf. :class:`~gudhi.AlphaComplex3D`) and -allows to construct standard and weighted versions of alpha complexes.
\ No newline at end of file +allows to construct standard and weighted versions of alpha complexes. + +Remark +"""""" + +* Contrary to the dD version, with the 3d version, the vertices in the output simplex tree are not guaranteed to match + the order of the input points. One can use :func:`~gudhi.AlphaComplex3D.get_point` to get the initial point back. |