diff options
| author | Marc Glisse <marc.glisse@inria.fr> | 2020-01-09 18:03:39 +0100 |
|---|---|---|
| committer | Marc Glisse <marc.glisse@inria.fr> | 2020-01-09 18:03:39 +0100 |
| commit | 18c98020adea4a7d0c53fe4e76c92bab23e7ad76 (patch) | |
| tree | 30cef4d252137a61411c9e546b8ca423d1d8c01d /src/python/gudhi/subsampling.pyx | |
| parent | bcc49c54943e20b117a3a83579d94f6c1b0efd04 (diff) | |
Spell out types as in PEP 484
but don't actually use annotations. A quick try with
sphinx-autodoc-typehints failed, I didn't investigate much, it can wait.
Diffstat (limited to 'src/python/gudhi/subsampling.pyx')
| -rw-r--r-- | src/python/gudhi/subsampling.pyx | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/src/python/gudhi/subsampling.pyx b/src/python/gudhi/subsampling.pyx index 04f66219..f50f4b0c 100644 --- a/src/python/gudhi/subsampling.pyx +++ b/src/python/gudhi/subsampling.pyx @@ -33,7 +33,7 @@ def choose_n_farthest_points(points=None, off_file='', nb_points=0, starting_poi The iteration starts with the landmark `starting point`. :param points: The input point set. - :type points: list(list(float)). + :type points: Iterable[Iterable[float]]. Or @@ -47,7 +47,7 @@ def choose_n_farthest_points(points=None, off_file='', nb_points=0, starting_poi index is chosen randomly. :type starting_point: unsigned. :returns: The subsample point set. - :rtype: list(list(float)). + :rtype: List[List[float]]. """ if off_file: if os.path.isfile(off_file): @@ -74,7 +74,7 @@ def pick_n_random_points(points=None, off_file='', nb_points=0): """Subsample a point set by picking random vertices. :param points: The input point set. - :type points: list(list(float)). + :type points: Iterable[Iterable[float]]. Or @@ -84,7 +84,7 @@ def pick_n_random_points(points=None, off_file='', nb_points=0): :param nb_points: Number of points of the subsample. :type nb_points: unsigned. :returns: The subsample point set. - :rtype: list(list(float)) + :rtype: List[List[float]] """ if off_file: if os.path.isfile(off_file): @@ -103,7 +103,7 @@ def sparsify_point_set(points=None, off_file='', min_squared_dist=0.0): between any two points is greater than or equal to min_squared_dist. :param points: The input point set. - :type points: list(list(float)). + :type points: Iterable[Iterable[float]]. Or @@ -114,7 +114,7 @@ def sparsify_point_set(points=None, off_file='', min_squared_dist=0.0): points. :type min_squared_dist: float. :returns: The subsample point set. - :rtype: list(list(float)) + :rtype: List[List[float]] """ if off_file: if os.path.isfile(off_file): |