summaryrefslogtreecommitdiff
path: root/src/python/gudhi/datasets/generators
diff options
context:
space:
mode:
authorHind-M <hind.montassif@gmail.com>2021-09-22 15:20:03 +0200
committerHind-M <hind.montassif@gmail.com>2021-09-22 15:20:03 +0200
commite23ca84fadcc2c65fd8cf2d141be804bf18b2fd6 (patch)
treed33da76449f363df2c2d1c8f5d2981596c7e5163 /src/python/gudhi/datasets/generators
parent65619d48af98680294bf41c4023e04ee94f2745d (diff)
Rename function of torus cpp version and import it with sphere in points
Change documentation accordingly
Diffstat (limited to 'src/python/gudhi/datasets/generators')
-rw-r--r--src/python/gudhi/datasets/generators/_points.cc9
-rw-r--r--src/python/gudhi/datasets/generators/points.py3
2 files changed, 9 insertions, 3 deletions
diff --git a/src/python/gudhi/datasets/generators/_points.cc b/src/python/gudhi/datasets/generators/_points.cc
index 3d38ff90..536fa949 100644
--- a/src/python/gudhi/datasets/generators/_points.cc
+++ b/src/python/gudhi/datasets/generators/_points.cc
@@ -96,10 +96,10 @@ PYBIND11_MODULE(_points, m) {
:returns: the generated points on a sphere.
)pbdoc");
- m.def("torus", &generate_points_on_torus,
+ m.def("ctorus", &generate_points_on_torus,
py::arg("n_samples"), py::arg("dim"), py::arg("sample") = "random",
R"pbdoc(
- Generate random i.i.d. points on a d-torus in R^2d
+ Generate random i.i.d. points on a d-torus in R^2d or as a grid
:param n_samples: The number of points to be generated.
:type n_samples: integer
@@ -107,7 +107,10 @@ PYBIND11_MODULE(_points, m) {
:type dim: integer
:param sample: The sample type. Available values are: `"random"` and `"grid"`. Default value is `"random"`.
:type sample: string
- :rtype: numpy array of float
+ :rtype: numpy array of float.
+ The shape of returned numpy array is :
+ if sample is 'random' : (n_samples, 2*dim).
+ if sample is 'grid' : ([n_samples**(1./dim)]**dim, 2*dim).
:returns: the generated points on a torus.
)pbdoc");
}
diff --git a/src/python/gudhi/datasets/generators/points.py b/src/python/gudhi/datasets/generators/points.py
index daada486..1995f769 100644
--- a/src/python/gudhi/datasets/generators/points.py
+++ b/src/python/gudhi/datasets/generators/points.py
@@ -10,6 +10,9 @@
import numpy as np
import itertools
+from ._points import ctorus
+from ._points import sphere
+
def _generate_random_points_on_torus(n_samples, dim):
# Generate random angles of size n_samples*dim