summaryrefslogtreecommitdiff
path: root/src/python/gudhi/datasets/generators/_points.cc
diff options
context:
space:
mode:
Diffstat (limited to 'src/python/gudhi/datasets/generators/_points.cc')
-rw-r--r--src/python/gudhi/datasets/generators/_points.cc2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/python/gudhi/datasets/generators/_points.cc b/src/python/gudhi/datasets/generators/_points.cc
index 536fa949..5d675930 100644
--- a/src/python/gudhi/datasets/generators/_points.cc
+++ b/src/python/gudhi/datasets/generators/_points.cc
@@ -110,7 +110,7 @@ PYBIND11_MODULE(_points, m) {
: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).
+ if sample is 'grid' : (⌊n_samples**(1./dim)⌋**dim, 2*dim), where shape[0] is rounded down to the closest perfect 'dim'th power.
:returns: the generated points on a torus.
)pbdoc");
}