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/reader_utils.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/reader_utils.pyx')
-rw-r--r-- | src/python/gudhi/reader_utils.pyx | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/python/gudhi/reader_utils.pyx b/src/python/gudhi/reader_utils.pyx index 5a756e4b..9ced6bca 100644 --- a/src/python/gudhi/reader_utils.pyx +++ b/src/python/gudhi/reader_utils.pyx @@ -34,7 +34,7 @@ def read_lower_triangular_matrix_from_csv_file(csv_file='', separator=';'): :type separator: char :returns: The lower triangular matrix. - :rtype: list(list(float)) + :rtype: List[List[float]] """ if csv_file: if path.isfile(csv_file): @@ -46,14 +46,14 @@ def read_persistence_intervals_grouped_by_dimension(persistence_file=''): """Reads a file containing persistence intervals. Each line might contain 2, 3 or 4 values: [[field] dimension] birth death The return value is a `dict(dim, list(tuple(birth, death)))` - where `dim` is an `int`, `birth` a `double`, and `death` a `double`. + where `dim` is an `int`, `birth` a `float`, and `death` a `float`. Note: the function does not check that birth <= death. :param persistence_file: A persistence file style name. :type persistence_file: string :returns: The persistence pairs grouped by dimension. - :rtype: dict(int, list(tuple(float, float))) + :rtype: Dict[int, List[Tuple[float, float]]] """ if persistence_file: if path.isfile(persistence_file): |