summaryrefslogtreecommitdiff
path: root/src/python/doc
diff options
context:
space:
mode:
authorMarc Glisse <marc.glisse@inria.fr>2020-03-28 11:48:43 +0100
committerMarc Glisse <marc.glisse@inria.fr>2020-03-28 11:48:43 +0100
commit35a12b553c85af8ce31629b90a27a7071b0cc379 (patch)
tree795fbe61b893a88cd0ac64c249dad276bcf36de2 /src/python/doc
parent68839b95e7751afd04155cd2565cc53362f01fa2 (diff)
Doc tweaks, default DTM exponent
Diffstat (limited to 'src/python/doc')
-rw-r--r--src/python/doc/point_cloud.rst6
-rw-r--r--src/python/doc/point_cloud_sum.inc4
2 files changed, 6 insertions, 4 deletions
diff --git a/src/python/doc/point_cloud.rst b/src/python/doc/point_cloud.rst
index 351b0786..192f70db 100644
--- a/src/python/doc/point_cloud.rst
+++ b/src/python/doc/point_cloud.rst
@@ -28,11 +28,12 @@ Time Delay Embedding
:members:
:special-members: __call__
-Nearest neighbors
------------------
+K nearest neighbors
+-------------------
.. automodule:: gudhi.point_cloud.knn
:members:
+ :undoc-members:
:special-members: __init__
Distance to measure
@@ -40,4 +41,5 @@ Distance to measure
.. automodule:: gudhi.point_cloud.dtm
:members:
+ :undoc-members:
:special-members: __init__
diff --git a/src/python/doc/point_cloud_sum.inc b/src/python/doc/point_cloud_sum.inc
index ecc18951..d4761aba 100644
--- a/src/python/doc/point_cloud_sum.inc
+++ b/src/python/doc/point_cloud_sum.inc
@@ -2,8 +2,8 @@
:widths: 30 40 30
+----------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
- | | :math:`(x_1, x_2, \ldots, x_d)` | Utilities to process point clouds: read from file, subsample, etc. | :Author: Vincent Rouvreau |
- | | :math:`(y_1, y_2, \ldots, y_d)` | | |
+ | | :math:`(x_1, x_2, \ldots, x_d)` | Utilities to process point clouds: read from file, subsample, | :Authors: Vincent Rouvreau, Marc Glisse, Masatoshi Takenouchi |
+ | | :math:`(y_1, y_2, \ldots, y_d)` | find neighbors, embed time series in higher dimension, etc. | |
| | | :Since: GUDHI 2.0.0 |
| | | |
| | | :License: MIT (`GPL v3 </licensing/>`_, BSD-3-Clause, Apache-2.0) |