summaryrefslogtreecommitdiff
path: root/src/python/gudhi
diff options
context:
space:
mode:
Diffstat (limited to 'src/python/gudhi')
-rw-r--r--src/python/gudhi/datasets/generators/_points.cc2
-rw-r--r--src/python/gudhi/datasets/generators/points.py6
2 files changed, 4 insertions, 4 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");
}
diff --git a/src/python/gudhi/datasets/generators/points.py b/src/python/gudhi/datasets/generators/points.py
index 1995f769..7f4667af 100644
--- a/src/python/gudhi/datasets/generators/points.py
+++ b/src/python/gudhi/datasets/generators/points.py
@@ -36,15 +36,15 @@ def _generate_grid_points_on_torus(n_samples, dim):
def torus(n_samples, dim, sample='random'):
"""
- Generate points on a dim-torus in R^2dim either randomly or on a grid
+ Generate points on a flat dim-torus in R^2dim either randomly or on a grid
:param n_samples: The number of points to be generated.
:param dim: The dimension of the torus on which points would be generated in R^2*dim.
:param sample: The sample type of the generated points. Can be 'random' or 'grid'.
:returns: numpy array containing the generated points on a torus.
- The shape of returned numpy array is :
+ 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.
"""
if sample == 'random':
# Generate points randomly