diff options
author | Marc Glisse <marc.glisse@inria.fr> | 2020-01-18 22:56:22 +0100 |
---|---|---|
committer | Marc Glisse <marc.glisse@inria.fr> | 2020-01-18 22:56:22 +0100 |
commit | f5e49792f809b198908a67e674672a676c0877ec (patch) | |
tree | 6f68f7507e1f08e81603482ae47d67294ab1026d /src/python/gudhi | |
parent | 0ab5f895846f1d773157181b6aa47c2d96488841 (diff) |
Separate optional arguments from common arguments
I copy-pasted what is done in RipsComplex. Before that, sphinx was
grouping nb_points with off_file, as if it couldn't be used with points.
Diffstat (limited to 'src/python/gudhi')
-rw-r--r-- | src/python/gudhi/subsampling.pyx | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/src/python/gudhi/subsampling.pyx b/src/python/gudhi/subsampling.pyx index 4c84cb03..f77c6f75 100644 --- a/src/python/gudhi/subsampling.pyx +++ b/src/python/gudhi/subsampling.pyx @@ -40,6 +40,8 @@ def choose_n_farthest_points(points=None, off_file='', nb_points=0, starting_poi :param off_file: An OFF file style name. :type off_file: string + And in both cases + :param nb_points: Number of points of the subsample. :type nb_points: unsigned. :param starting_point: The iteration starts with the landmark `starting \ @@ -81,6 +83,8 @@ def pick_n_random_points(points=None, off_file='', nb_points=0): :param off_file: An OFF file style name. :type off_file: string + And in both cases + :param nb_points: Number of points of the subsample. :type nb_points: unsigned. :returns: The subsample point set. @@ -110,6 +114,8 @@ def sparsify_point_set(points=None, off_file='', min_squared_dist=0.0): :param off_file: An OFF file style name. :type off_file: string + And in both cases + :param min_squared_dist: Minimum squared distance separating the output \ points. :type min_squared_dist: float. |